HomeGlossary

Exported Services

OFBiz services that are exposed via REST interface with export attribute set to true

Wrapper Service For Adding Category Products

post

Wrapper Service For Adding Category Products

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addCategoryProducts request

fromDatestring · dateOptional
productCategoryIdstringRequired
productIdstring[]Required
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/addCategoryProducts
POST /rest/services/addCategoryProducts HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "fromDate": "2025-11-12",
  "productCategoryId": "text",
  "productId": [
    "text"
  ],
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Service for indexing data to Solr

post

Service for indexing data to Solr

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addDataToSearchIndex request

updateHandlerstringOptional
datastring[]Required
coreNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/addDataToSearchIndex
POST /rest/services/addDataToSearchIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Bulk Add Facility To FacilityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addFacilitiesToGroup request

payloadobjectRequired
Responses
200

Success response for the API call.

application/json
post
/services/addFacilitiesToGroup
POST /rest/services/addFacilitiesToGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "payload": {}
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Add Facility To FacilityGroup

post

Add Facility To FacilityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addFacilityToGroup request

fromDatestring · dateOptional
facilityIdstringRequired
sequenceNuminteger · int32Optional
facilityGroupIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/addFacilityToGroup
POST /rest/services/addFacilityToGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 110

{
  "fromDate": "2025-11-12",
  "facilityId": "text",
  "sequenceNum": 1,
  "facilityGroupId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a FacilityParty record

post

Create a FacilityParty record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addPartyToFacility request

fromDatestring · dateOptional
roleTypeIdstringRequired
facilityIdstringRequired
partyIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/addPartyToFacility
POST /rest/services/addPartyToFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "fromDate": "2025-11-12",
  "roleTypeId": "text",
  "facilityId": "text",
  "partyId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addPartyUserPermission request

userLoginIdstringRequired
groupIdsstring[]Required
Responses
200

Success response for the API call.

application/json
post
/services/addPartyUserPermission
POST /rest/services/addPartyUserPermission HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "userLoginId": "text",
  "groupIds": [
    "text"
  ]
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "userLoginId": "text"
  }
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addProductToFacility request

allowPickupstringOptional
reorderPointnumberOptional
facilityIdstringRequired
productIdstringRequired
salesVelocitynumberOptional
allowBrokeringstringOptional
reorderQuantitynumberOptional
inventoryItemIdstringOptional
lastInventoryCountnumberOptional
computedLastInventoryCountnumberOptional
minimumStocknumberOptional
requirementMethodEnumIdstringOptional
maximumStocknumberOptional
daysToShipinteger · int32Optional
Responses
200

Success response for the API call.

application/json
post
/services/addProductToFacility
POST /rest/services/addProductToFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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"
  }
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addSecurityGroupToUserLogin request

securityGroupIdstringRequired
partyIdTostringRequired
Responses
200

Success response for the API call.

application/json
post
/services/addSecurityGroupToUserLogin
POST /rest/services/addSecurityGroupToUserLogin HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Add a SecurityPermission to a SecurityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addSecurityPermissionToSecurityGroup request

fromDatestring · dateRequired
permissionIdstringRequired
groupIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/addSecurityPermissionToSecurityGroup
POST /rest/services/addSecurityPermissionToSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 88

{
  "fromDate": "2025-11-12",
  "permissionId": "text",
  "groupId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items

post

Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addShipmentPackage request

carrierPartyIdstringOptional
boxLengthstringOptional
dimensionUomIdstringOptional
boxNumberstringOptional
boxHeightstringOptional
boxWidthstringOptional
picklistBinIdstringRequired
shipmentBoxTypeIdstringOptional
shipmentMethodTypeIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/addShipmentPackage
POST /rest/services/addShipmentPackage HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Add a UserLogin to a SecurityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: addUserLoginToSecurityGroup request

fromDatestring · dateOptional
userLoginIdstringRequired
groupIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/addUserLoginToSecurityGroup
POST /rest/services/addUserLoginToSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "fromDate": "2025-11-12",
  "userLoginId": "text",
  "groupId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: allocateOrderItemToFacility request

orderItemSeqIdstringRequired
clearAutoCancelDatebooleanOptional
commentsstringOptional
facilityIdstringRequired
suggestedShipMethodTypeIdstringOptional
orderIdstringRequired
autoCancelDatestring · dateOptional
routingRuleIdstringOptional
toShipGroupSeqIdstringOptional
routingGroupIdstringOptional
routingRulestringOptional
orderRoutingIdstringOptional
changeReasonEnumIdstringOptional
routingRunIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/allocateOrderItemToFacility
POST /rest/services/allocateOrderItemToFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 340

{
  "orderItemSeqId": "text",
  "clearAutoCancelDate": true,
  "comments": "text",
  "facilityId": "text",
  "suggestedShipMethodTypeId": "text",
  "orderId": "text",
  "autoCancelDate": "2025-11-12",
  "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

post

Append an item to an existing order

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: appendOrderItem request

amountnumberOptional
itemAttributesMapobjectOptional
quantitynumberRequired
productIdstringRequired
orderIdstringRequired
overridePricestringOptional
autoCancelDatestring · dateOptional
offInvoicePricenumberOptional
disableResetGrandTotalbooleanOptional
quantityUomIdstringOptional
shipAmountnumberOptional
shipGroupSeqIdstringRequired
surveyResponsesstring[]Optional
unitListPricenumberOptional
changeCommentsstringOptional
calcTaxbooleanOptional
discountModestringOptional
itemDesiredDeliveryDatestring · dateOptional
reasonEnumIdstringOptional
discountValuenumberOptional
orderItemTypeIdstringOptional
basePricenumberOptional
prodCatalogIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/appendOrderItem
POST /rest/services/appendOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 496

{
  "amount": 1,
  "itemAttributesMap": {},
  "quantity": 1,
  "productId": "text",
  "orderId": "text",
  "overridePrice": "text",
  "autoCancelDate": "2025-11-12",
  "offInvoicePrice": 1,
  "disableResetGrandTotal": true,
  "quantityUomId": "text",
  "shipAmount": 1,
  "shipGroupSeqId": "text",
  "surveyResponses": [
    "text"
  ],
  "unitListPrice": 1,
  "changeComments": "text",
  "calcTax": true,
  "discountMode": "text",
  "itemDesiredDeliveryDate": "2025-11-12",
  "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

post

Change status of sales order to approved after validating certain checks which must be performed before approving order

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: approveSalesOrder request

orderIdstringRequired
confirmApprovestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/approveSalesOrder
POST /rest/services/approveSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Adjust Shopify inventory level.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: bulkAdjustInventoryLevelOnShopify request

adjustInventoryListstring[]Optional
shopifyConfigIdstringRequired
facilityIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/bulkAdjustInventoryLevelOnShopify
POST /rest/services/bulkAdjustInventoryLevelOnShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Mark transfer order as Approved in bulk

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: bulkApproveTransferOrders request

bufferTimeinteger · int32Optional
orderIdsstring[]Optional
Responses
200

Success response for the API call.

application/json
post
/services/bulkApproveTransferOrders
POST /rest/services/bulkApproveTransferOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Mark all orders items as picked in bulk

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: bulkPackStoreFulfillmentOrders request

shipmentIdsstring[]Optional
Responses
200

Success response for the API call.

application/json
post
/services/bulkPackStoreFulfillmentOrders
POST /rest/services/bulkPackStoreFulfillmentOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Route all in progress orders to rebrokering

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: bulkRejectStoreInProgressOrders request

facilityIdstringRequired
reasonIdstringOptional
productStoreIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/bulkRejectStoreInProgressOrders
POST /rest/services/bulkRejectStoreInProgressOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Route all outstanding orders to rebrokering

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: bulkRejectStoreOutstandingOrders request

facilityIdstringRequired
reasonIdstringOptional
productStoreIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/bulkRejectStoreOutstandingOrders
POST /rest/services/bulkRejectStoreOutstandingOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Mark shipments as Shipped in bulk

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: bulkShipOrders request

shipmentIdstring[]Optional
Responses
200

Success response for the API call.

application/json
post
/services/bulkShipOrders
POST /rest/services/bulkShipOrders HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a calendar and save calendar week details

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: calendarDataSetup request

sundayCapacitystringOptional
thursdayCapacitystringOptional
wednesdayStartTimestringOptional
wednesdayCapacitystringOptional
tuesdayStartTimestringOptional
fridayStartTimestringOptional
descriptionstringOptional
saturdayCapacitystringOptional
mondayCapacitystringOptional
mondayStartTimestringOptional
calendarIdstringOptional
saturdayStartTimestringOptional
thursdayStartTimestringOptional
sundayStartTimestringOptional
fridayCapacitystringOptional
tuesdayCapacitystringOptional
Responses
200

Success response for the API call.

application/json
post
/services/calendarDataSetup
POST /rest/services/calendarDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Cancel an Order Item Quantity

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: cancelOrderItem request

orderItemSeqIdstringOptional
itemReasonMapobjectOptional
orderIdstringRequired
itemCommentMapobjectOptional
itemQtyMapobjectOptional
shipGroupSeqIdstringOptional
cancelQuantitynumberOptional
Responses
200

Success response for the API call.

application/json
post
/services/cancelOrderItem
POST /rest/services/cancelOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Cancel Order Item Quantity for order

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: cancelOrderItems request

itemReasonMapobjectOptional
orderIdstringRequired
cancelableItemMapobjectOptional
shipGrpItemQtyMapobjectOptional
Responses
200

Success response for the API call.

application/json
post
/services/cancelOrderItems
POST /rest/services/cancelOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

checking whether fulfillment started for the order, if its not then order would be cancelled

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: cancelSalesOrder request

changeReasonstringOptional
orderIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/cancelSalesOrder
POST /rest/services/cancelSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "changeReason": "text",
  "orderId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Cancels a schedule job

post

Cancels a schedule job

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: cancelScheduledJob request

jobIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/cancelScheduledJob
POST /rest/services/cancelScheduledJob HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "jobId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "statusId": "text",
    "cancelDateTime": "2025-11-12"
  }
}

Change the status of an existing order item. If no orderItemSeqId is specified, the status of all order items will be changed.

post

Change the status of an existing order item. If no orderItemSeqId is specified, the status of all order items will be changed.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: changeOrderItemStatus request

orderItemSeqIdstringOptional
changeReasonstringOptional
statusIdstringRequired
orderIdstringRequired
statusDateTimestring · dateOptional
fromStatusIdstringOptional
changeReasonEnumIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/changeOrderItemStatus
POST /rest/services/changeOrderItemStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 162

{
  "orderItemSeqId": "text",
  "changeReason": "text",
  "statusId": "text",
  "orderId": "text",
  "statusDateTime": "2025-11-12",
  "fromStatusId": "text",
  "changeReasonEnumId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Change the status of an existing order

post

Change the status of an existing order

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: changeOrderStatus request

setItemStatusstringOptional
changeReasonstringOptional
statusIdstringRequired
orderIdstringRequired
changeReasonEnumIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/changeOrderStatus
POST /rest/services/changeOrderStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Check if fulfillment started for item and then reject it

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: checkAndRejectOrderItem request

orderItemSeqIdstringRequired
excludeOrderFacilityDurationstringOptional
orderIdstringRequired
rejectionCommentsstringOptional
rejectionReasonstringOptional
notifybooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/checkAndRejectOrderItem
POST /rest/services/checkAndRejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

This service will check the list of attributes on the passed order and approve it if all the passed attributes are present

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: checkAttributesAndApproveOrder request

orderIdstringOptional
attributesobjectOptional
Responses
200

Success response for the API call.

application/json
post
/services/checkAttributesAndApproveOrder
POST /rest/services/checkAttributesAndApproveOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Clears all values from all Entity Engine caches. By default does not distribute.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: clearAllEntityCaches request

distributebooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/clearAllEntityCaches
POST /rest/services/clearAllEntityCaches HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Clear Cache Line with a condition; By default does not distribute.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: clearCacheLineByCondition request

entityNamestringRequired
distributebooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/clearCacheLineByCondition
POST /rest/services/clearCacheLineByCondition HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: clearCacheLineByDummyPK request

distributebooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/clearCacheLineByDummyPK
POST /rest/services/clearCacheLineByDummyPK HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Clear Cache Line with a primaryKey (GenericPK); clears the all and by primary key caches. By default does not distribute.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: clearCacheLineByPrimaryKey request

distributebooleanOptional
primaryKeyobjectRequired
Responses
200

Success response for the API call.

application/json
post
/services/clearCacheLineByPrimaryKey
POST /rest/services/clearCacheLineByPrimaryKey HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: clearCacheLineByValue request

distributebooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/clearCacheLineByValue
POST /rest/services/clearCacheLineByValue HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a new Carrier Shipment Box Type Record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createCarrierShipmentBoxType request

packagingTypeCodestringOptional
oversizeCodestringOptional
partyIdstringRequired
shipmentBoxTypeIdstringRequired
pickupContainerCodestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createCarrierShipmentBoxType
POST /rest/services/createCarrierShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Creates A CarrierShipmentMethod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createCarrierShipmentMethod request

sequenceNumberinteger · int32Optional
roleTypeIdstringRequired
deliveryDaysinteger · int32Optional
partyIdstringRequired
carrierServiceCodestringOptional
shipmentMethodTypeIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createCarrierShipmentMethod
POST /rest/services/createCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createCommercePartyRelationshipFrom request

roleTypeIdTostringOptional
partyRelationshipTypeIdstringOptional
partyIdFromstringOptional
statusIdstringOptional
partyIdTostringRequired
roleTypeIdFromstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createCommercePartyRelationshipFrom
POST /rest/services/createCommercePartyRelationshipFrom HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a Communication Event with permission check

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createCommunicationEvent request

workEffortIdstringOptional
notestringOptional
partyIdFromstringOptional
orderIdstringOptional
ccStringstringOptional
subjectstringOptional
contactMechTypeIdstringOptional
communicationEventTypeIdstringOptional
contentstringOptional
contentMimeTypeIdstringOptional
datetimeStartedstring · dateOptional
returnIdstringOptional
contactListIdstringOptional
actionstringOptional
custRequestIdstringOptional
contactMechIdFromstringOptional
reasonEnumIdstringOptional
roleTypeIdTostringOptional
productIdstringOptional
entryDatestring · dateOptional
parentCommEventIdstringOptional
systemMessageRemoteIdstringOptional
datetimeEndedstring · dateOptional
externalIdstringOptional
messageIdstringOptional
origCommEventIdstringOptional
roleTypeIdFromstringOptional
contactMechIdTostringOptional
headerStringstringOptional
statusIdstringOptional
communicationEventIdstringOptional
bccStringstringOptional
toStringstringOptional
partyIdTostringOptional
fromStringstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createCommunicationEvent
POST /rest/services/createCommunicationEvent HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
  "returnId": "text",
  "contactListId": "text",
  "action": "text",
  "custRequestId": "text",
  "contactMechIdFrom": "text",
  "reasonEnumId": "text",
  "roleTypeIdTo": "text",
  "productId": "text",
  "entryDate": "2025-11-12",
  "parentCommEventId": "text",
  "systemMessageRemoteId": "text",
  "datetimeEnded": "2025-11-12",
  "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

post

Create a Communication Event Order

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createCommunicationEventOrder request

orderIdstringRequired
communicationEventIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createCommunicationEventOrder
POST /rest/services/createCommunicationEventOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "orderId": "text",
  "communicationEventId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a DataManagerConfig

post

Create a DataManagerConfig

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createDataManagerConfig request

importPathstringOptional
exportServiceScreenLocationstringOptional
exportServiceScreenNamestringOptional
importServiceNamestringOptional
fileNamePatternstringOptional
multiThreadingstringOptional
descriptionstringOptional
priorityinteger · int32Optional
exportPathstringOptional
exportContentIdstringOptional
notifyOnFailurestringOptional
delimiterstringOptional
configIdstringOptional
exportServiceNamestringOptional
scriptTitlestringOptional
executionModeIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createDataManagerConfig
POST /rest/services/createDataManagerConfig HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a DataManagerMapping

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createDataManagerMapping request

fromDatestring · dateOptional
mappingPrefNamestringOptional
mappingPrefTypeEnumIdstringOptional
mappingPrefIdstringOptional
mappingPrefValuestringOptional
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createDataManagerMapping
POST /rest/services/createDataManagerMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "fromDate": "2025-11-12",
  "mappingPrefName": "text",
  "mappingPrefTypeEnumId": "text",
  "mappingPrefId": "text",
  "mappingPrefValue": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "mappingPrefId": "text"
  }
}

Create a Enumeration

post

Create a Enumeration

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createEnumeration request

enumTypeIdstringRequired
enumIdstringOptional
sequenceNuminteger · int32Optional
enumCodestringOptional
primaryEnumerationGroupIdstringOptional
descriptionstringRequired
enumNamestringOptional
sequenceIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createEnumeration
POST /rest/services/createEnumeration HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create enumeration group member

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createEnumerationGroupMember request

fromDatestring · dateRequired
enumerationIdstringRequired
sequenceNuminteger · int32Optional
enumerationGroupIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createEnumerationGroupMember
POST /rest/services/createEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "fromDate": "2025-11-12",
  "enumerationId": "text",
  "sequenceNum": 1,
  "enumerationGroupId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Service for create excluded order facility record for all order items

post

Service for create excluded order facility record for all order items

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createExcludedOrderFacilityForOrder request

externalOrderFacilityIdstringOptional
orderIdstringOptional
externalOrderIdstringOptional
orderFacilityIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createExcludedOrderFacilityForOrder
POST /rest/services/createExcludedOrderFacilityForOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a Facility

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacility request

facilityIdstringOptional
defaultInventoryItemTypeIdstringOptional
parentFacilityIdstringOptional
postalCodestringOptional
externalIdstringOptional
descriptionstringOptional
defaultWeightUomIdstringOptional
primaryFacilityGroupIdstringOptional
openedDatestring · dateOptional
ownerPartyIdstringRequired
facilityTimeZonestringOptional
facilitySizenumberOptional
closedDatestring · dateOptional
facilitySizeUomIdstringOptional
maximumOrderLimitinteger · int32Optional
closeTimestringOptional
defaultDaysToShipinteger · int32Optional
facilityTypeIdstringRequired
defaultDimensionUomIdstringOptional
productStoreIdstringOptional
facilityNamestringRequired
openTimestringOptional
geoPointIdstringOptional
oldSquareFootageinteger · int32Optional
Responses
200

Success response for the API call.

application/json
post
/services/createFacility
POST /rest/services/createFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
  "ownerPartyId": "text",
  "facilityTimeZone": "text",
  "facilitySize": 1,
  "closedDate": "2025-11-12",
  "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

post

Create a FacilityCalendar

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityCalendar request

fromDatestring · dateRequired
facilityIdstringRequired
calendarIdstringRequired
facilityCalendarTypeIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityCalendar
POST /rest/services/createFacilityCalendar HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "fromDate": "2025-11-12",
  "facilityId": "text",
  "calendarId": "text",
  "facilityCalendarTypeId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a FacilityContactMech

post

Create a FacilityContactMech

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityContactMech request

fromDatestring · dateOptional
extensionstringOptional
commentsstringOptional
facilityIdstringOptional
infoStringstringOptional
contactMechPurposeTypeIdstringOptional
externalIdstringOptional
contactMechTypeIdstringOptional
contactMechIdstringOptional
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityContactMech
POST /rest/services/createFacilityContactMech HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "fromDate": "2025-11-12",
  "extension": "text",
  "comments": "text",
  "facilityId": "text",
  "infoString": "text",
  "contactMechPurposeTypeId": "text",
  "externalId": "text",
  "contactMechTypeId": "text",
  "contactMechId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "contactMechId": "text"
  }
}

Create an Email Address

post

Create an Email Address

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityEmailAddress request

fromDatestring · dateOptional
emailAddressstringRequired
extensionstringOptional
commentsstringOptional
facilityIdstringOptional
infoStringstringOptional
contactMechPurposeTypeIdstringOptional
externalIdstringOptional
contactMechTypeIdstringOptional
contactMechIdstringOptional
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityEmailAddress
POST /rest/services/createFacilityEmailAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "fromDate": "2025-11-12",
  "emailAddress": "text",
  "extension": "text",
  "comments": "text",
  "facilityId": "text",
  "infoString": "text",
  "contactMechPurposeTypeId": "text",
  "externalId": "text",
  "contactMechTypeId": "text",
  "contactMechId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "contactMechId": "text"
  }
}

Create a Facility Group

post

Create a Facility Group

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityGroup request

primaryParentGroupIdstringOptional
facilityGroupTypeIdstringRequired
facilityGroupIdstringOptional
descriptionstringOptional
facilityGroupNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityGroup
POST /rest/services/createFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a FacilityIdentification

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityIdentification request

fromDatestring · dateOptional
facilityIdstringRequired
idValuestringOptional
facilityIdenTypeIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityIdentification
POST /rest/services/createFacilityIdentification HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "fromDate": "2025-11-12",
  "facilityId": "text",
  "idValue": "text",
  "facilityIdenTypeId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a Facility Location

post

Create a Facility Location

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityLocation request

nextCountDatestringOptional
lastCountDatestringOptional
facilityIdstringRequired
areaIdstringOptional
positionIdstringOptional
isLockedstringOptional
levelIdstringOptional
sectionIdstringOptional
geoPointIdstringOptional
locationTypeEnumIdstringOptional
aisleIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityLocation
POST /rest/services/createFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a Postal Address

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityPostalAddress request

houseNumberExtstringOptional
extensionstringOptional
citystringRequired
latitudestringOptional
postalCodeGeoIdstringOptional
postalCodestringOptional
houseNumberinteger · int32Optional
postalCodeExtstringOptional
contactMechIdstringRequired
attnNamestringOptional
countyGeoIdstringOptional
toNamestringOptional
paymentMethodIdstringOptional
cityGeoIdstringOptional
longitudestringOptional
countryGeoIdstringOptional
commentsstringOptional
facilityIdstringOptional
address2stringOptional
address1stringRequired
encodedAddressKeystringOptional
thruDatestring · dateOptional
fromDatestring · dateOptional
contactMechPurposeTypeIdstringOptional
directionsstringOptional
municipalityGeoIdstringOptional
stateProvinceGeoIdstringOptional
geoPointIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityPostalAddress
POST /rest/services/createFacilityPostalAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
  "fromDate": "2025-11-12",
  "contactMechPurposeTypeId": "text",
  "directions": "text",
  "municipalityGeoId": "text",
  "stateProvinceGeoId": "text",
  "geoPointId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "contactMechId": "text"
  }
}

Create a Telecommunications Number

post

Create a Telecommunications Number

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createFacilityTelecomNumber request

fromDatestring · dateOptional
askForNamestringOptional
areaCodestringOptional
extensionstringOptional
commentsstringOptional
facilityIdstringOptional
contactMechPurposeTypeIdstringOptional
countryCodestringOptional
contactNumberstringOptional
contactMechIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createFacilityTelecomNumber
POST /rest/services/createFacilityTelecomNumber HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "fromDate": "2025-11-12",
  "askForName": "text",
  "areaCode": "text",
  "extension": "text",
  "comments": "text",
  "facilityId": "text",
  "contactMechPurposeTypeId": "text",
  "countryCode": "text",
  "contactNumber": "text",
  "contactMechId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "contactMechId": "text"
  }
}

Creates the fulfillment log

post

Creates the fulfillment log

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createGcFulFillmentRecord request

referenceNumstringOptional
orderItemSeqIdstringOptional
amountnumberOptional
authCodestringOptional
orderIdstringOptional
merchantIdstringOptional
pinNumberstringOptional
typeEnumIdstringRequired
surveyResponseIdstringOptional
partyIdstringOptional
cardNumberstringOptional
responseCodestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createGcFulFillmentRecord
POST /rest/services/createGcFulFillmentRecord HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create Shopify Return in HC

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createIncomingShipment request

payloadobjectRequired
Responses
200

Success response for the API call.

application/json
post
/services/createIncomingShipment
POST /rest/services/createIncomingShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Creates a New User Login and Set it's default Organization by creating User Preference entity record.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createNewUserLoginAndSetUserPreference request

userLoginIdstringRequired
userPrefGroupTypeIdstringOptional
passwordHintstringOptional
userPrefValuestringOptional
currentPasswordVerifystringRequired
externalAuthIdstringOptional
requirePasswordChangestringOptional
userPrefTypeIdstringRequired
partyIdstringOptional
userPrefLoginIdstringOptional
enabledstringOptional
currentPasswordstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createNewUserLoginAndSetUserPreference
POST /rest/services/createNewUserLoginAndSetUserPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Service for creating the index for a single OISGIR.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createOISGIRIndex request

inventoryItemIdstringOptional
orderItemSeqIdstringOptional
orderIdstringOptional
shipmentIdstringOptional
tenantIdstringOptional
shipGroupSeqIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createOISGIRIndex
POST /rest/services/createOISGIRIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Service to create order appeasement

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createOrderAppeasement request

orderIdstringRequired
appeasementAmountnumberOptional
itemAmountMapobjectOptional
Responses
200

Success response for the API call.

application/json
post
/services/createOrderAppeasement
POST /rest/services/createOrderAppeasement HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create an OrderAttribute record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createOrderAttribute request

orderIdstringRequired
attrDescriptionstringOptional
attrValuestringOptional
attrNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createOrderAttribute
POST /rest/services/createOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create Order Indexes

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createOrderIndex request

orderItemSeqIdstringOptional
orderIdstringRequired
tenantIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createOrderIndex
POST /rest/services/createOrderIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create Order Item Attribute

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createOrderItemAttribute request

orderItemSeqIdstringRequired
orderIdstringRequired
attrDescriptionstringOptional
attrValuestringOptional
attrNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createOrderItemAttribute
POST /rest/services/createOrderItemAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a PartyGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createPartyGroup request

pdfLogoImageUrlstringOptional
commentsstringOptional
externalIdstringOptional
descriptionstringOptional
tickerSymbolstringOptional
logoImageUrlstringOptional
partyTypeIdstringOptional
groupNamestringRequired
groupNameLocalstringOptional
statusIdstringOptional
numEmployeesinteger · int32Optional
preferredCurrencyUomIdstringOptional
rankinginteger · int32Optional
partyIdstringOptional
annualRevenuenumberOptional
officeSiteNamestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createPartyGroup
POST /rest/services/createPartyGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a Postal Address

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createPostalAddress request

countryGeoIdstringOptional
houseNumberExtstringOptional
citystringRequired
address2stringOptional
address1stringRequired
latitudenumberOptional
postalCodeGeoIdstringOptional
postalCodestringOptional
encodedAddressKeystringOptional
houseNumberinteger · int32Optional
postalCodeExtstringOptional
contactMechIdstringRequired
attnNamestringOptional
countyGeoIdstringOptional
directionsstringOptional
toNamestringOptional
cityGeoIdstringOptional
municipalityGeoIdstringOptional
stateProvinceGeoIdstringOptional
geoPointIdstringOptional
longitudenumberOptional
Responses
200

Success response for the API call.

application/json
post
/services/createPostalAddress
POST /rest/services/createPostalAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create an ProductFacilityLocation

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductFacilityLocation request

facilityIdstringRequired
productIdstringRequired
moveQuantitynumberOptional
minimumStocknumberOptional
maximumStocknumberOptional
locationSeqIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createProductFacilityLocation
POST /rest/services/createProductFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Create Index for single product.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductIndex request

productIdstringOptional
indexVariantsbooleanOptional
tenantIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createProductIndex
POST /rest/services/createProductIndex HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a ProductStoreFacility

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductStoreFacility request

fromDatestring · dateRequired
facilityIdstringRequired
sequenceNuminteger · int32Optional
productStoreIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createProductStoreFacility
POST /rest/services/createProductStoreFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "fromDate": "2025-11-12",
  "facilityId": "text",
  "sequenceNum": 1,
  "productStoreId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a ProductStoreFacilityGroup

post

Create a ProductStoreFacilityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductStoreFacilityGroup request

fromDatestring · dateRequired
sequenceNumberinteger · int32Optional
facilityGroupIdstringRequired
productStoreIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createProductStoreFacilityGroup
POST /rest/services/createProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "fromDate": "2025-11-12",
  "sequenceNumber": 1,
  "facilityGroupId": "text",
  "productStoreId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create ProductStoreRole

post

Create ProductStoreRole

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductStoreRole request

fromDatestring · dateOptional
roleTypeIdstringRequired
sequenceNuminteger · int32Optional
productStoreIdstringRequired
partyIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/createProductStoreRole
POST /rest/services/createProductStoreRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "fromDate": "2025-11-12",
  "roleTypeId": "text",
  "sequenceNum": 1,
  "productStoreId": "text",
  "partyId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a ProductStoreSetting

post

Create a ProductStoreSetting

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductStoreSetting request

settingValuestringOptional
productStoreIdstringRequired
settingTypeEnumIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createProductStoreSetting
POST /rest/services/createProductStoreSetting HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a Product Store Shipment Method

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createProductStoreShipMeth request

companyPartyIdstringOptional
productStoreShipMethIdstringRequired
allowancePercentnumberOptional
shipmentCustomMethodIdstringOptional
includeFeatureGroupstringOptional
minTotalnumberOptional
minWeightnumberOptional
requireCompanyAddrstringOptional
maxSizenumberOptional
excludeGeoIdstringOptional
isShippingWeightRequiredstringOptional
shipmentGatewayConfigIdstringOptional
minSizenumberOptional
allowCompanyAddrstringOptional
productStoreIdstringRequired
minimumPricenumberOptional
partyIdstringRequired
shipmentMethodTypeIdstringRequired
excludeFeatureGroupstringOptional
sequenceNumberinteger · int32Optional
roleTypeIdstringRequired
allowUspsAddrstringOptional
maxWeightnumberOptional
serviceNamestringOptional
thruDatestring · dateOptional
fromDatestring · dateOptional
includeGeoIdstringOptional
maxTotalnumberOptional
requireUspsAddrstringOptional
configPropsstringOptional
includeNoChargeItemsstringOptional
isTrackingRequiredstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createProductStoreShipMeth
POST /rest/services/createProductStoreShipMeth HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
  "fromDate": "2025-11-12",
  "includeGeoId": "text",
  "maxTotal": 1,
  "requireUspsAddr": "text",
  "configProps": "text",
  "includeNoChargeItems": "text",
  "isTrackingRequired": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "productStoreShipMethId": "text"
  }
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createPurchaseShipment request

facilityIdstringRequired
orderIdstringRequired
shipGroupSeqIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createPurchaseShipment
POST /rest/services/createPurchaseShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create Relationship record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createRelationship request

roleTypeIdTostringOptional
partyIdFromstringOptional
lastNamestringOptional
extensionstringOptional
phoneContactMechPurposestringOptional
externalIdstringOptional
roleTypeIdFromstringOptional
thruDatestring · dateOptional
fromDatestring · dateOptional
partyRelationshipTypeIdstringOptional
firstNamestringOptional
partyTypeIdstringRequired
emailAddressstringOptional
groupNamestringOptional
statusIdstringOptional
preferredCurrencyUomIdstringOptional
emailContactMechPurposestringOptional
contactNumberstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createRelationship
POST /rest/services/createRelationship HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 426

{
  "roleTypeIdTo": "text",
  "partyIdFrom": "text",
  "lastName": "text",
  "extension": "text",
  "phoneContactMechPurpose": "text",
  "externalId": "text",
  "roleTypeIdFrom": "text",
  "thruDate": "2025-11-12",
  "fromDate": "2025-11-12",
  "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

post

Create return/sales return based on API input parameters

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createReturn request

Responses
200

Success response for the API call.

application/json
post
/services/createReturn
POST /rest/services/createReturn HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a new role type

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createRoleType request

roleTypeIdstringRequired
parentTypeIdstringOptional
descriptionstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createRoleType
POST /rest/services/createRoleType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create Order Data based on API input parameters

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createSalesOrder request

Responses
200

Success response for the API call.

application/json
post
/services/createSalesOrder
POST /rest/services/createSalesOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create Search Preference

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createSearchPreference request

searchPrefNamestringOptional
isPublicstringOptional
searchPrefValuestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createSearchPreference
POST /rest/services/createSearchPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create an SecurityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createSecurityGroup request

groupNamestringOptional
groupIdstringRequired
descriptionstringOptional
groupTypeEnumIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createSecurityGroup
POST /rest/services/createSecurityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a SecurityPermission

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createSecurityPermission request

permissionIdstringRequired
descriptionstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createSecurityPermission
POST /rest/services/createSecurityPermission HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "permissionId": "text",
  "description": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create a ShipmentBoxType record

post

Create a ShipmentBoxType record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShipmentBoxType request

boxLengthnumberOptional
boxWeightnumberOptional
dimensionUomIdstringOptional
weightUomIdstringOptional
descriptionstringOptional
boxHeightnumberOptional
boxWidthnumberOptional
shipmentBoxTypeIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShipmentBoxType
POST /rest/services/createShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create ShipmentItem

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShipmentItem request

availableToPromisenumberOptional
serialNumberstringOptional
quantitynumberOptional
productIdstringOptional
shipmentContentDescriptionstringOptional
shipmentIdstringRequired
externalIdstringOptional
shipmentItemSeqIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShipmentItem
POST /rest/services/createShipmentItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Creates A ShipmentMethodType

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShipmentMethodType request

parentTypeIdstringOptional
sequenceNuminteger · int32Optional
descriptionstringOptional
shipmentMethodTypeIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createShipmentMethodType
POST /rest/services/createShipmentMethodType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Creates a ShipmentReceipt Record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShipmentReceipt request

orderItemSeqIdstringOptional
productIdstringRequired
orderIdstringOptional
quantityAcceptednumberRequired
shipmentPackageSeqIdstringOptional
quantityRejectednumberRequired
shipmentItemSeqIdstringOptional
inventoryItemDetailSeqIdstringOptional
affectAccountingbooleanOptional
rejectionIdstringOptional
inventoryItemIdstringRequired
receivedByUserLoginIdstringOptional
shipmentIdstringOptional
returnIdstringOptional
returnItemSeqIdstringOptional
datetimeReceivedstring · dateOptional
itemDescriptionstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShipmentReceipt
POST /rest/services/createShipmentReceipt HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
  "itemDescription": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "receiptId": "text",
    "affectAccounting": true
  }
}

Import Shopify Orders

post

Import Shopify Orders

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShopifyOrder request

shopifyConfigIdstringRequired
payloadobjectOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShopifyOrder
POST /rest/services/createShopifyOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Creates a ShopifyProdLocActivation record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShopifyProdLocActivation request

shopifyLocationIdstringOptional
shopIdstringOptional
shopifyProductIdstringOptional
activatedstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShopifyProdLocActivation
POST /rest/services/createShopifyProdLocActivation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create return/sales return based on API input parameters

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShopifyReturn request

Responses
200

Success response for the API call.

application/json
post
/services/createShopifyReturn
POST /rest/services/createShopifyReturn HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a ShopifyShopCarrierShipment record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShopifyShopCarrierShipment request

carrierPartyIdstringOptional
shopifyShippingMethodstringOptional
shopIdstringOptional
shipmentMethodTypeIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShopifyShopCarrierShipment
POST /rest/services/createShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create a ShopifyShopLocation record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createShopifyShopLocation request

facilityIdstringOptional
shopifyLocationIdstringOptional
shopIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createShopifyShopLocation
POST /rest/services/createShopifyShopLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create system property

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createSystemProperty request

systemPropertyValuestringOptional
systemResourceIdstringRequired
descriptionstringOptional
systemPropertyIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createSystemProperty
POST /rest/services/createSystemProperty HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create/Update Order Adjustment

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUpdateOrderAdjustment request

customerReferenceIdstringOptional
correspondingProductIdstringOptional
orderIdstringOptional
includeInShippingstringOptional
descriptionstringOptional
exemptAmountnumberOptional
productPromoIdstringOptional
taxAuthPartyIdstringOptional
lastModifiedByUserLoginstringOptional
oldPercentagenumberOptional
primaryGeoIdstringOptional
taxAuthGeoIdstringOptional
originalAdjustmentIdstringOptional
secondaryGeoIdstringOptional
createdByUserLoginstringOptional
amountAlreadyIncludednumberOptional
orderAdjustmentIdstringOptional
orderItemSeqIdstringOptional
amountnumberOptional
commentsstringOptional
recurringAmountnumberOptional
lastModifiedDatestring · dateOptional
sourceReferenceIdstringOptional
isManualstringOptional
productPromoRuleIdstringOptional
orderAdjustmentTypeIdstringOptional
taxAuthorityRateSeqIdstringOptional
productFeatureIdstringOptional
oldAmountPerQuantitynumberOptional
overrideGlAccountIdstringOptional
shipGroupSeqIdstringOptional
includeInTaxstringOptional
createdDatestring · dateOptional
productPromoActionSeqIdstringOptional
billingShipmentIdstringOptional
sourcePercentagenumberOptional
Responses
200

Success response for the API call.

application/json
post
/services/createUpdateOrderAdjustment
POST /rest/services/createUpdateOrderAdjustment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
  "sourceReferenceId": "text",
  "isManual": "text",
  "productPromoRuleId": "text",
  "orderAdjustmentTypeId": "text",
  "taxAuthorityRateSeqId": "text",
  "productFeatureId": "text",
  "oldAmountPerQuantity": 1,
  "overrideGlAccountId": "text",
  "shipGroupSeqId": "text",
  "includeInTax": "text",
  "createdDate": "2025-11-12",
  "productPromoActionSeqId": "text",
  "billingShipmentId": "text",
  "sourcePercentage": 1
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Create or update a OrderAttribute

post

Create or update a OrderAttribute

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUpdateOrderAttribute request

orderIdstringRequired
attrDescriptionstringOptional
attrValuestringOptional
attrNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createUpdateOrderAttribute
POST /rest/services/createUpdateOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create and Update email address

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUpdatePartyEmailAddress request

emailAddressstringRequired
contactMechPurposeTypeIdstringOptional
partyIdstringOptional
contactMechIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createUpdatePartyEmailAddress
POST /rest/services/createUpdatePartyEmailAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create and Update telecom number

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUpdatePartyTelecomNumber request

askForNamestringOptional
extensionstringOptional
roleTypeIdstringOptional
commentsstringOptional
verifiedstringOptional
monthsWithContactMechinteger · int32Optional
contactMechIdstringOptional
thruDatestring · dateOptional
fromDatestring · dateOptional
areaCodestringOptional
allowSolicitationstringOptional
yearsWithContactMechinteger · int32Optional
contactMechPurposeTypeIdstringOptional
countryCodestringOptional
contactNumberstringOptional
partyIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createUpdatePartyTelecomNumber
POST /rest/services/createUpdatePartyTelecomNumber HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "askForName": "text",
  "extension": "text",
  "roleTypeId": "text",
  "comments": "text",
  "verified": "text",
  "monthsWithContactMech": 1,
  "contactMechId": "text",
  "thruDate": "2025-11-12",
  "fromDate": "2025-11-12",
  "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

post

Creates new shipping address and update existing address

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUpdateShippingAddress request

setDefaultShippingstringOptional
shipToContactMechIdstringOptional
shipToStateProvinceGeoIdstringRequired
shipToCitystringRequired
keepAddressBookstringOptional
shipToPostalCodestringRequired
shipToAddress1stringRequired
billToContactMechIdstringOptional
shipToAddress2stringOptional
shipToCountryGeoIdstringRequired
shipToNamestringOptional
productStoreIdstringOptional
partyIdstringOptional
shipToAttnNamestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createUpdateShippingAddress
POST /rest/services/createUpdateShippingAddress HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Shop name eg. myshop is shop name for https://myshop.myshopify.com

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUpdateShopifyShop request

shopifyConfigIdstringOptional
clientIdstringRequired
shopstringRequired
processRefundstringOptional
shopifyConfigNamestringRequired
shopIdstringRequired
productStoreIdstringOptional
oldSharedSecretstringOptional
accessTokenstringRequired
sharedSecretstringOptional
webSiteIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/createUpdateShopifyShop
POST /rest/services/createUpdateShopifyShop HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Create User Search Preference

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: createUserSearchPreference request

fromDatestring · dateOptional
userSearchPrefTypeIdstringRequired
searchPrefIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/createUserSearchPreference
POST /rest/services/createUserSearchPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "fromDate": "2025-11-12",
  "userSearchPrefTypeId": "text",
  "searchPrefId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a CarrierGeoMapping record

post

Delete a CarrierGeoMapping record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteCarrierGeoMapping request

geoNamestringOptional
geoTypeIdstringOptional
carrierPartyIdstringOptional
geoMapIdstringRequired
geoIdstringOptional
carrierGeoValuestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/deleteCarrierGeoMapping
POST /rest/services/deleteCarrierGeoMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "geoName": "text",
  "geoTypeId": "text",
  "carrierPartyId": "text",
  "geoMapId": "text",
  "geoId": "text",
  "carrierGeoValue": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete an existing Carrier Shipment Box Type Record

post

Delete an existing Carrier Shipment Box Type Record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteCarrierShipmentBoxType request

partyIdstringRequired
shipmentBoxTypeIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteCarrierShipmentBoxType
POST /rest/services/deleteCarrierShipmentBoxType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "partyId": "text",
  "shipmentBoxTypeId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Deletes A CarrierShipmentMethod

post

Deletes A CarrierShipmentMethod

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteCarrierShipmentMethod request

roleTypeIdstringRequired
partyIdstringRequired
shipmentMethodTypeIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteCarrierShipmentMethod
POST /rest/services/deleteCarrierShipmentMethod HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Delete a DataManagerMapping

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteDataManagerMapping request

mappingPrefIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteDataManagerMapping
POST /rest/services/deleteDataManagerMapping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "mappingPrefId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a Enumeration

post

Delete a Enumeration

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteEnumeration request

enumIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteEnumeration
POST /rest/services/deleteEnumeration HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "enumId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete enumeration group member

post

Delete enumeration group member

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteEnumerationGroupMember request

fromDatestring · dateRequired
enumerationIdstringRequired
enumerationGroupIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteEnumerationGroupMember
POST /rest/services/deleteEnumerationGroupMember HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "fromDate": "2025-11-12",
  "enumerationId": "text",
  "enumerationGroupId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a ExternalFulfillmentOrderItem record

post

Delete a ExternalFulfillmentOrderItem record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteExternalFulfillmentOrderItem request

externalFulfillmentOrderItemIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteExternalFulfillmentOrderItem
POST /rest/services/deleteExternalFulfillmentOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "externalFulfillmentOrderItemId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a Facility Group

post

Delete a Facility Group

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteFacilityGroup request

facilityGroupIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteFacilityGroup
POST /rest/services/deleteFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "facilityGroupId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a Facility Location

post

Delete a Facility Location

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteFacilityLocation request

facilityIdstringRequired
locationSeqIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteFacilityLocation
POST /rest/services/deleteFacilityLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "facilityId": "text",
  "locationSeqId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete an OrderAttribute record

post

Delete an OrderAttribute record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteOrderAttribute request

orderIdstringRequired
attrNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteOrderAttribute
POST /rest/services/deleteOrderAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "orderId": "text",
  "attrName": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete Order Item Attribute

post

Delete Order Item Attribute

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteOrderItemAttribute request

orderItemSeqIdstringRequired
orderIdstringRequired
attrNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteOrderItemAttribute
POST /rest/services/deleteOrderItemAttribute HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Delete a PartyContactMech

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deletePartyContactMech request

partyIdstringOptional
contactMechIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deletePartyContactMech
POST /rest/services/deletePartyContactMech HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deletePartyRole request

roleTypeIdstringRequired
partyIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deletePartyRole
POST /rest/services/deletePartyRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "roleTypeId": "text",
  "partyId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a ProductStoreFacilityGroup

post

Delete a ProductStoreFacilityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteProductStoreFacilityGroup request

fromDatestring · dateRequired
facilityGroupIdstringRequired
productStoreIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteProductStoreFacilityGroup
POST /rest/services/deleteProductStoreFacilityGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "fromDate": "2025-11-12",
  "facilityGroupId": "text",
  "productStoreId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete ShipmentItem

post

Delete ShipmentItem

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteShipmentItem request

shipmentIdstringRequired
shipmentItemSeqIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteShipmentItem
POST /rest/services/deleteShipmentItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "shipmentId": "text",
  "shipmentItemSeqId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Deletes A ShipmentMethodType

post

Deletes A ShipmentMethodType

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteShipmentMethodType request

shipmentMethodTypeIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteShipmentMethodType
POST /rest/services/deleteShipmentMethodType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "shipmentMethodTypeId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Delete a ShopifyShopCarrierShipment record

post

Delete a ShopifyShopCarrierShipment record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteShopifyShopCarrierShipment request

carrierPartyIdstringOptional
shopifyShippingMethodstringRequired
shopIdstringRequired
shipmentMethodTypeIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/deleteShopifyShopCarrierShipment
POST /rest/services/deleteShopifyShopCarrierShipment HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Delete a ShopifyShopLocation record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: deleteShopifyShopLocation request

facilityIdstringRequired
shopifyLocationIdstringOptional
shopIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/deleteShopifyShopLocation
POST /rest/services/deleteShopifyShopLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "facilityId": "text",
  "shopifyLocationId": "text",
  "shopId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: doRateShopping request

shipmentIdstringRequired
forceRateShopbooleanOptional
generateLabelbooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/doRateShopping
POST /rest/services/doRateShopping HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Ensure that the party is in the specified role.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: ensurePartyRole request

roleTypeIdstringRequired
partyIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/ensurePartyRole
POST /rest/services/ensurePartyRole HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Send a post request to run a DAG in airflow

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: executeServiceFromAirflow request

payloadobjectOptional
dagIdstringRequired
airflowPayloadobjectOptional
serviceNamestringRequired
Responses
200

Success response for the API call.

application/json
post
/services/executeServiceFromAirflow
POST /rest/services/executeServiceFromAirflow HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Expire a FacilityCalendar Record

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: expireFacilityCalendar request

fromDatestring · dateRequired
facilityIdstringRequired
calendarIdstringRequired
facilityCalendarTypeIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/expireFacilityCalendar
POST /rest/services/expireFacilityCalendar HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "fromDate": "2025-11-12",
  "facilityId": "text",
  "calendarId": "text",
  "facilityCalendarTypeId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue

get

Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/findProductById
GET /rest/services/findProductById HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "productsList": [
      "text"
    ]
  }
}

Set hasLoggedOut to Y.

post

Set hasLoggedOut to Y.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: forceLogout request

userLoginIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/forceLogout
POST /rest/services/forceLogout HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "userLoginId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Address Validation Request

post

Address Validation Request

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: gatewayShipAddressValidationRequest request

carrierPartyIdstringOptional
shipmentGatewayConfigIdstringOptional
shipmentMethodTypeIdstringOptional
contactMechIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/gatewayShipAddressValidationRequest
POST /rest/services/gatewayShipAddressValidationRequest HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Check for shopify order to approve

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: generateCustomerOrderUpdateLink request

orderIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/generateCustomerOrderUpdateLink
POST /rest/services/generateCustomerOrderUpdateLink HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "orderId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "url": "text"
  }
}

Service for generate manifest

post

Service for generate manifest

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: generateManifests request

carrierPartyIdstringOptional
facilityIdstringRequired
manifestGenerateServiceNamestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/generateManifests
POST /rest/services/generateManifests HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "carrierPartyId": "text",
  "facilityId": "text",
  "manifestGenerateServiceName": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getCODOrderRemainingTotal
GET /rest/services/getCODOrderRemainingTotal HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "total": 1
  }
}

Send a post request to run a DAG in airflow

get

Send a post request to run a DAG in airflow

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getDAGRunStatus
GET /rest/services/getDAGRunStatus HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Get facilityId by identification type ID

get

Get facilityId by identification type ID

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getFacilityIdByType
GET /rest/services/getFacilityIdByType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "facilityId": "text"
  }
}

Returns the geoPoint for country postal code

get

Returns the geoPoint for country postal code

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getGeoPointForPostalCode
GET /rest/services/getGeoPointForPostalCode HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "cacheKey": "text",
    "geoPoint": {}
  }
}

Get Inventory Availability for a Product constrained by a facilityId

get

Get Inventory Availability for a Product constrained by a facilityId

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getInventoryAvailableByFacility
GET /rest/services/getInventoryAvailableByFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

get

Get Inventory Availability for a Product constrained by a facility and location

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getInventoryAvailableByLocation
GET /rest/services/getInventoryAvailableByLocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "quantityOnHandTotal": 1,
    "accountingQuantityTotal": 1,
    "availableToPromiseTotal": 1
  }
}

Get orderId by order identification type ID

get

Get orderId by order identification type ID

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getOrderIdByType
GET /rest/services/getOrderIdByType HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "orderId": "text"
  }
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getProductFutureAtp
GET /rest/services/getProductFutureAtp HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "futureAtp": 1
  }
}

Get Inventory Availability for a Product

get

Get Inventory Availability for a Product

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getProductInventoryAvailable
GET /rest/services/getProductInventoryAvailable HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "quantityOnHandTotal": 1,
    "accountingQuantityTotal": 1,
    "availableToPromiseTotal": 1
  }
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getProductOnlineAtp
GET /rest/services/getProductOnlineAtp HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "onlineAtp": 1
  }
}
get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getServerTimeZone
GET /rest/services/getServerTimeZone HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "serverTimeZone": "text"
  }
}

Main method to get shipping label from Third Party Shipping Services

get

Main method to get shipping label from Third Party Shipping Services

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getShippingLabel
GET /rest/services/getShippingLabel HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Get Shopify draft order.

get

Get Shopify draft order.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getShopifyDraftOrder
GET /rest/services/getShopifyDraftOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: text

{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "response": {}
  }
}

Get Shopify Webhooks created from API

get

Get Shopify Webhooks created from API

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getShopifyWebhooks
GET /rest/services/getShopifyWebhooks HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

get

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
inParamsanyRequired

Service In Parameters in JSON

Header parameters
AcceptstringRequiredExample: application/json
Responses
200

Success response for the API call.

application/json
get
/services/getUserPreference
GET /rest/services/getUserPreference HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

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.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: importJsonListData request

dataListstring[]Required
Responses
200

Success response for the API call.

application/json
post
/services/importJsonListData
POST /rest/services/importJsonListData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "dataList": [
    "text"
  ]
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: importProductFacility request

allowPickupstringOptional
productSkustringOptional
reorderPointstringOptional
idTypestringOptional
facilityIdstringOptional
productIdstringOptional
facilityExternalIdstringOptional
salesVelocitystringOptional
allowBrokeringstringOptional
reorderQuantitystringOptional
maximumStockstringOptional
facilityMinimumStockstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/importProductFacility
POST /rest/services/importProductFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Service for fetching indexing instance details to Solr

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: indexDeploymentData request

updateHandlerstringOptional
coreNamestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/indexDeploymentData
POST /rest/services/indexDeploymentData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Service for indexing instance details to Solr recieved from API call

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: indexExternalDeploymentData request

updateHandlerstringOptional
deploymentDataobjectRequired
coreNamestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/indexExternalDeploymentData
POST /rest/services/indexExternalDeploymentData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Service for indexing webhook error details to Solr

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: indexWebhookErrorMessage request

payloadobjectOptional
remoteUrlstringOptional
commentstringOptional
topicEnumIdstringOptional
coreNamestringOptional
Responses
200

Success response for the API call.

application/json
post
/services/indexWebhookErrorMessage
POST /rest/services/indexWebhookErrorMessage HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Inventory update service triggers on Shopify Inventory Level Update webhook

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: inventoryLevelUpdateFromShopify request

shopifyConfigIdstringRequired
inventory_item_idinteger · int32Required
availableinteger · int32Required
location_idinteger · int32Required
Responses
200

Success response for the API call.

application/json
post
/services/inventoryLevelUpdateFromShopify
POST /rest/services/inventoryLevelUpdateFromShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: moveItemToParkingFacility request

fromShipGroupSeqIdstringRequired
orderItemSeqIdstringRequired
commentsstringOptional
orderIdstringRequired
changeReasonEnumIdstringOptional
toFacilityIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/moveItemToParkingFacility
POST /rest/services/moveItemToParkingFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Check if fulfillment started for item and then reject it

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: oldCheckAndRejectOrderItem request

orderItemSeqIdstringRequired
excludeOrderFacilityDurationstringOptional
orderIdstringRequired
rejectionCommentsstringOptional
rejectionReasonstringOptional
notifybooleanOptional
Responses
200

Success response for the API call.

application/json
post
/services/oldCheckAndRejectOrderItem
POST /rest/services/oldCheckAndRejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Reject Order Item

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: oldRejectOrderItem request

payloadobjectOptional
rejectedComponentsstring[]Optional
Responses
200

Success response for the API call.

application/json
post
/services/oldRejectOrderItem
POST /rest/services/oldRejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Reject Order Line Item

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: oldRejectOrderItems request

payloadobjectOptional
Responses
200

Success response for the API call.

application/json
post
/services/oldRejectOrderItems
POST /rest/services/oldRejectOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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)

post

To import order usign csv (Either posted by script or uploaded from browser)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: orderDataSetup request

shippingCitystringOptional
lastNamestringOptional
externalPlacingFacilityIdstringOptional
orderIdstringOptional
orderTypeIdstringOptional
originExternalFacilityIdstringOptional
shippingPostalCodestringOptional
shippingAddress2stringOptional
externalFacilityIdstringOptional
shippingAddress1stringOptional
shippingTaxstringOptional
externalProductStoreIdstringOptional
unitListPricestringOptional
shippingCountrystringOptional
itemStatusstringOptional
salesChannelEnumCodestringOptional
customerIdstringOptional
productStoreIdstringOptional
shipmentMethodTypeIdstringOptional
orderItemTypeIdstringOptional
orderNamestringOptional
unitPricestringOptional
quantitystringOptional
idTypestringOptional
facilityIdstringOptional
productIdstringOptional
shippingChargesstringOptional
grandTotalstringOptional
customerExternalIdstringOptional
externalIdstringOptional
idValuestringOptional
shippingPhonestringOptional
placingFacilityIdstringOptional
orderIdentificationstringOptional
itemTotalDiscountstringOptional
originFacilityIdstringOptional
carrierPartyIdstringOptional
firstNamestringOptional
itemExternalIdstringOptional
paymentMethodstringOptional
shippingStatestringOptional
itemTaxstringOptional
orderDatestringOptional
shippingEmailstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/orderDataSetup
POST /rest/services/orderDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

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.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: orderFulfillmentAllocation request

orderIdstringOptional
externalOrderIdstringOptional
facilityAllocationstring[]Required
Responses
200

Success response for the API call.

application/json
post
/services/orderFulfillmentAllocation
POST /rest/services/orderFulfillmentAllocation HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Mark picklist bin items as Picked

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: packStoreFulfillmentOrder request

orderIdstringRequired
picklistBinIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/packStoreFulfillmentOrder
POST /rest/services/packStoreFulfillmentOrder HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Imports picklist And Picklist Item

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: picklistDataSetup request

inventoryItemIdstringOptional
orderItemSeqIdstringOptional
picklistIdstringOptional
quantitystringOptional
facilityIdstringOptional
pickerIdsstring[]Optional
pickedstringOptional
orderIdstringOptional
externalIdstringOptional
shipGroupSeqIdstringOptional
shipmentMethodTypeIdstringOptional
itemStatusIdstringOptional
binLocationNumberinteger · int32Optional
Responses
200

Success response for the API call.

application/json
post
/services/picklistDataSetup
POST /rest/services/picklistDataSetup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Pull And Report Entity Sync Data

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: pullAndReportEntitySyncData request

delegatorNamestringOptional
entitySyncIdstringRequired
toStoreUpdatedinteger · int32Optional
toCreateInsertedinteger · int32Optional
toCreateUpdatedinteger · int32Optional
toCreateNotUpdatedinteger · int32Optional
toRemoveAlreadyDeletedinteger · int32Optional
toStoreNotUpdatedinteger · int32Optional
toRemoveDeletedinteger · int32Optional
toStoreInsertedinteger · int32Optional
startDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/pullAndReportEntitySyncData
POST /rest/services/pullAndReportEntitySyncData HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": {
    "valuesToStore": [
      "text"
    ],
    "keysToRemove": [
      "text"
    ],
    "valuesToCreate": [
      "text"
    ],
    "startDate": "2025-11-12"
  }
}

Service to reship completed order items

post

Service to reship completed order items

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: reShipOrderItems request

orderItemSeqIdstring[]Required
orderIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/reShipOrderItems
POST /rest/services/reShipOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Recieve Incoming Shipment and push Inventory on Shopify

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: receiveAndUpdateInventoryToShopify request

shipmentIdstringRequired
limitinteger · int32Optional
shopIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/receiveAndUpdateInventoryToShopify
POST /rest/services/receiveAndUpdateInventoryToShopify HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

This service is used to record inventory variance

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: recordInventoryCount request

reasonstringOptional
commentsstringOptional
quantitystringOptional
facilityIdstringRequired
idTypestringOptional
productIdstringOptional
idValuestringOptional
locationSeqIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/recordInventoryCount
POST /rest/services/recordInventoryCount HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: recordProductVariance request

orderItemSeqIdstringOptional
varianceReasonIdstringOptional
commentsstringOptional
quantitynumberOptional
facilityIdstringOptional
productIdstringOptional
orderIdstringOptional
locationSeqIdstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/recordProductVariance
POST /rest/services/recordProductVariance HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Reject in progress shipment item.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: rejectFulfillmentReadyOrderItem request

affectQOHbooleanOptional
excludeOrderFacilityDurationinteger · int32Optional
facilityIdstringRequired
rejectAllRelatedShipmentstringOptional
rejectEntireShipmentstringOptional
itemsstring[]Required
defaultReasonstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/rejectFulfillmentReadyOrderItem
POST /rest/services/rejectFulfillmentReadyOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Reject Order Item

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: rejectOrderItem request

payloadobjectOptional
rejectedComponentsstring[]Optional
Responses
200

Success response for the API call.

application/json
post
/services/rejectOrderItem
POST /rest/services/rejectOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Reject Order Line Item

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: rejectOrderItems request

payloadobjectOptional
Responses
200

Success response for the API call.

application/json
post
/services/rejectOrderItems
POST /rest/services/rejectOrderItems HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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.

post

Cancel reservations and if fulfillent started cancel shipment also.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: rejectTransferOrderItem request

orderItemSeqIdstringRequired
orderIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/rejectTransferOrderItem
POST /rest/services/rejectTransferOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Service to release Order Item from one facility to another

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: releaseOrderItem request

orderItemSeqIdstringRequired
routerUserLoginstringOptional
fromFacilityIdstringOptional
orderIdstringRequired
changeReasonEnumIdstringOptional
toFacilityIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/releaseOrderItem
POST /rest/services/releaseOrderItem HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Wrapper Service For Removing Category Products

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: removeCategoryProducts request

fromDatestring · dateRequired
productCategoryIdstringRequired
productIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/removeCategoryProducts
POST /rest/services/removeCategoryProducts HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "fromDate": "2025-11-12",
  "productCategoryId": "text",
  "productId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Remove firebase client registration token

post

Remove firebase client registration token

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: removeClientRegistrationToken request

applicationIdstringRequired
deviceIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/removeClientRegistrationToken
POST /rest/services/removeClientRegistrationToken HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "applicationId": "text",
  "deviceId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Remove Facility From FacilityGroup

post

Remove Facility From FacilityGroup

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: removeFacilityFromGroup request

fromDatestring · dateRequired
facilityIdstringRequired
facilityGroupIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/removeFacilityFromGroup
POST /rest/services/removeFacilityFromGroup HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "fromDate": "2025-11-12",
  "facilityId": "text",
  "facilityGroupId": "text"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Removing association of a Party from Facility

post

Removing association of a Party from Facility

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: removePartyFromFacility request

fromDatestring · dateRequired
roleTypeIdstringRequired
facilityIdstringRequired
partyIdstringRequired
thruDatestring · dateOptional
Responses
200

Success response for the API call.

application/json
post
/services/removePartyFromFacility
POST /rest/services/removePartyFromFacility HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "fromDate": "2025-11-12",
  "roleTypeId": "text",
  "facilityId": "text",
  "partyId": "text",
  "thruDate": "2025-11-12"
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: removePartyUserPermission request

userLoginIdstringRequired
groupIdstringRequired
Responses
200

Success response for the API call.

application/json
post
/services/removePartyUserPermission
POST /rest/services/removePartyUserPermission HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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

post

Remove existing webhook on Shopify

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: removeShopifyWebhook request

shopifyConfigIdstringRequired
webhookIdinteger · int32Required
Responses
200

Success response for the API call.

application/json
post
/services/removeShopifyWebhook
POST /rest/services/removeShopifyWebhook HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "shopifyConfigId": "text",
  "webhookId": 1
}
{
  "statusCode": 1,
  "statusDescription": "text",
  "successMessage": "text",
  "data": null
}

Reset Password

post

Reset Password

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: resetPassword request

userLoginIdstringOptional
newPasswordVerifystringOptional
passwordHintstringOptional
newPasswordstringOptional
requirePasswordChangestringOptional
currentPasswordstringOptional
Responses
200

Success response for the API call.

application/json
post
/services/resetPassword
POST /rest/services/resetPassword HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
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-11-12",
      "isExternal": "text",
      "passwordHint": "text",
      "createdTxStamp": "2025-11-12",
      "createdStamp": "2025-11-12",
      "externalAuthId": "text",
      "lastUpdatedTxStamp": "2025-11-12",
      "lastTimeZone": "text",
      "enabled": "text",
      "lastLocale": "text",
      "currentPassword": "text",
      "userLoginId": "text",
      "isSystem": "text",
      "disabledDateTime": "2025-11-12",
      "disabledBy": "text",
      "hasLoggedOut": "text",
      "userLdapDn": "text",
      "requirePasswordChange": "text",
      "lastCurrencyUom": "text",
      "partyId": "text"
    }
  }
}

Reset all pickers on picklist.

post

Reset all pickers on picklist.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
Content-TypestringRequiredExample: application/json
Body

In Schema for service: resetPicker request

picklistIdstringRequired
pickerIdsstring[]Required
Responses
200

Success response for the API call.

application/json
post
/services/resetPicker
POST /rest/services/resetPicker HTTP/1.1
Host: 10.106.39.100:443
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "picklistId": "text",
  "pickerIds": [
    "text"
  ]
}