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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "productCategoryId": "text",
  "productId": [
    "text"
  ],
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "facilityId": "text",
  "sequenceNum": 1,
  "facilityGroupId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "roleTypeId": "text",
  "facilityId": "text",
  "partyId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "permissionId": "text",
  "groupId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "userLoginId": "text",
  "groupId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "offInvoicePrice": 1,
  "disableResetGrandTotal": true,
  "quantityUomId": "text",
  "shipAmount": 1,
  "shipGroupSeqId": "text",
  "surveyResponses": [
    "text"
  ],
  "unitListPrice": 1,
  "changeComments": "text",
  "calcTax": true,
  "discountMode": "text",
  "itemDesiredDeliveryDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16"
  }
}

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "returnId": "text",
  "contactListId": "text",
  "action": "text",
  "custRequestId": "text",
  "contactMechIdFrom": "text",
  "reasonEnumId": "text",
  "roleTypeIdTo": "text",
  "productId": "text",
  "entryDate": "2025-12-16",
  "parentCommEventId": "text",
  "systemMessageRemoteId": "text",
  "datetimeEnded": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "mappingPrefName": "text",
  "mappingPrefTypeEnumId": "text",
  "mappingPrefId": "text",
  "mappingPrefValue": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "enumerationId": "text",
  "sequenceNum": 1,
  "enumerationGroupId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "ownerPartyId": "text",
  "facilityTimeZone": "text",
  "facilitySize": 1,
  "closedDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "facilityId": "text",
  "calendarId": "text",
  "facilityCalendarTypeId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "extension": "text",
  "comments": "text",
  "facilityId": "text",
  "infoString": "text",
  "contactMechPurposeTypeId": "text",
  "externalId": "text",
  "contactMechTypeId": "text",
  "contactMechId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "emailAddress": "text",
  "extension": "text",
  "comments": "text",
  "facilityId": "text",
  "infoString": "text",
  "contactMechPurposeTypeId": "text",
  "externalId": "text",
  "contactMechTypeId": "text",
  "contactMechId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "facilityId": "text",
  "idValue": "text",
  "facilityIdenTypeId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "fromDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "askForName": "text",
  "areaCode": "text",
  "extension": "text",
  "comments": "text",
  "facilityId": "text",
  "contactMechPurposeTypeId": "text",
  "countryCode": "text",
  "contactNumber": "text",
  "contactMechId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "facilityId": "text",
  "sequenceNum": 1,
  "productStoreId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "sequenceNumber": 1,
  "facilityGroupId": "text",
  "productStoreId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "roleTypeId": "text",
  "sequenceNum": 1,
  "productStoreId": "text",
  "partyId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "fromDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "fromDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "sourceReferenceId": "text",
  "isManual": "text",
  "productPromoRuleId": "text",
  "orderAdjustmentTypeId": "text",
  "taxAuthorityRateSeqId": "text",
  "productFeatureId": "text",
  "oldAmountPerQuantity": 1,
  "overrideGlAccountId": "text",
  "shipGroupSeqId": "text",
  "includeInTax": "text",
  "createdDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "fromDate": "2025-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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-12-16",
  "facilityId": "text",
  "calendarId": "text",
  "facilityCalendarTypeId": "text",
  "thruDate": "2025-12-16"
}

{
  "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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

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

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getInventoryAvailableByLocation

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getOrderIdByType

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getProductFutureAtp

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getProductInventoryAvailable

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getProductOnlineAtp

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getServerTimeZone

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getShippingLabel

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getShopifyDraftOrder

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getShopifyWebhooks

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

get

/services/getUserPreference

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/importJsonListData

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/importProductFacility

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/indexDeploymentData

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/indexExternalDeploymentData

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/indexWebhookErrorMessage

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/inventoryLevelUpdateFromShopify

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/moveItemToParkingFacility

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/oldCheckAndRejectOrderItem

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/oldRejectOrderItem

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/oldRejectOrderItems

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/orderDataSetup

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/orderFulfillmentAllocation

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/packStoreFulfillmentOrder

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/picklistDataSetup

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/pullAndReportEntitySyncData

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/reShipOrderItems

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/receiveAndUpdateInventoryToShopify

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/recordInventoryCount

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/recordProductVariance

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/rejectFulfillmentReadyOrderItem

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/rejectOrderItem

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/rejectOrderItems

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/rejectTransferOrderItem

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/releaseOrderItem

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/removeCategoryProducts

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/removeClientRegistrationToken

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/removeFacilityFromGroup

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/removePartyFromFacility

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/removePartyUserPermission

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/removeShopifyWebhook

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/resetPassword

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/resetPicker

Send order Webhook message using Webhook Config.

post

Send order Webhook message using Webhook Config.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: sendOrderWebhook request

orderIdstringRequired

topicEnumIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/sendOrderWebhook

Send a pickup scheduled notification for all type of shipment.

post

Send a pickup scheduled notification for all type of shipment.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: sendPickupScheduledNotification request

emailTypestringOptional

shipmentIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/sendPickupScheduledNotification

Send a ready to pick up item notification for STOREPICKUP type

post

Send a ready to pick up item notification for STOREPICKUP type

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: sendReadyToPickupItemNotification request

emailTypestringOptional

shipmentIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/sendReadyToPickupItemNotification

This service will create/update preferred store(default facility) of a customer

post

This service will create/update preferred store(default facility) of a customer

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: setCustomerDefaultStore request

facilityIdstringRequired

customerIdstringRequired

shopDomainstringOptional

shopifyShopIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/setCustomerDefaultStore

Set/update Reason Id on Return Item

post

Set/update Reason Id on Return Item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: setReasonIdOnReturnItem request

reasonstringOptional

returnReasonIdstringRequired

shopifyReturnIdstringRequired

shopifyOrderLineItemIdstringRequired

shopifyOrderIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/setReasonIdOnReturnItem

Sets a single user preference.

post

Sets a single user preference.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: setUserPreference request

userPrefGroupTypeIdstringOptional

userPrefValuestringRequired

userPrefTypeIdstringRequired

userPrefLoginIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/setUserPreference

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: setupShopifyShop request

accessScopeEnumIdstringOptional

shopifyConfigIdstringRequired

clientIdstringRequired

shopstringRequired

processRefundstringOptional

shopifyConfigNamestringRequired

shopIdstringRequired

productStoreIdstringOptional

oldSharedSecretstringOptional

accessTokenstringRequired

sharedSecretstringOptional

webSiteIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/setupShopifyShop

Create association of store with a calendar

post

Create association of store with a calendar

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: storeCalendarAssocDataSetup request

calendarIdstringOptional

thruDateStrstringOptional

fromDateStrstringOptional

storeIdstringOptional

calendarTypeIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/storeCalendarAssocDataSetup

Store firebase client registration token

post

Store 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: storeClientRegistrationToken request

registrationTokenstringRequired

applicationIdstringRequired

deviceIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/storeClientRegistrationToken

Run Entity Sync

post

Run Entity Sync

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: storeEntitySyncData request

valuesToStorestring[]Required

delegatorNamestringOptional

entitySyncIdstringRequired

keysToRemovestring[]Required

valuesToCreatestring[]Required

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/storeEntitySyncData

Subscribe order cancel webhook on Shopify

post

Subscribe order cancel webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeCancelOrderShopifyWebhook request

endpointstringOptional

shopifyConfigIdstringRequired

topicstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeCancelOrderShopifyWebhook

Subscribe order create webhook on Shopify

post

Subscribe order create webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeCreateOrderShopifyWebhook request

endpointstringOptional

shopifyConfigIdstringRequired

topicstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeCreateOrderShopifyWebhook

Subscribe file status update webhook on Shopify

post

Subscribe file status update webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeFileStatusUpdateWebhook request

shopifyConfigIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeFileStatusUpdateWebhook

Subscribe order paid webhook on Shopify

post

Subscribe order paid webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeOrderPaidWebhook request

shopifyConfigIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeOrderPaidWebhook

Subscribe order return webhook on Shopify

post

Subscribe order return webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeReturnOrderShopifyWebhook request

endpointstringOptional

shopifyConfigIdstringRequired

topicstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeReturnOrderShopifyWebhook

Subscribe webhook on Shopify

post

Subscribe webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeShopifyWebhook request

endpointstringOptional

shopifyConfigIdstringRequired

formatstringOptional

topicstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeShopifyWebhook

Subscribe Topic

post

Subscribe Topic

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: subscribeTopic request

topicNamestringRequired

applicationIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/subscribeTopic

Test service

post

Test service

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: testCommit request

messagestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/testCommit

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

objectOptional

In Schema for service: testError request

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/testError

Test service

post

Test service

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: testRollback request

messagestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/testRollback

Test service

post

Test service

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: testScv request

defaultValuenumberOptional

messagestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/testScv

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: triggerDag request

endpointstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/triggerDag

This service unlinks return from the order, It won't delete the data from the entities.

post

This service unlinks return from the order, It won't delete the data from the entities.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: unlinkReturnFromOrder request

returnIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/unlinkReturnFromOrder

Unlock order item in a bin

post

Unlock order item in a bin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: unlockStoreFulfillmentOrder request

orderIdstringRequired

picklistBinIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/unlockStoreFulfillmentOrder

unsubscribe webhook on Shopify

post

unsubscribe webhook on Shopify

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: unsubscribeShopifyWebhook request

shopifyConfigIdstringRequired

topicstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/unsubscribeShopifyWebhook

Unsubscribe Topic

post

Unsubscribe Topic

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: unsubscribeTopic request

topicNamestringRequired

applicationIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/unsubscribeTopic

Updating all the orderItems, if the orderItemSeqId not provided in context.

post

Updating all the orderItems, if the orderItemSeqId not provided in context.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateAllOrderItems request

requestedDeliveryTimestringOptional

orderIdstringRequired

isNewProductstringOptional

returnTillDatestring · dateOptional

deploymentIdstringOptional

cancelBackOrderDatestring · dateOptional

itemDescriptionstringOptional

selectedAmountnumberOptional

unitPricenumberOptional

orderItemSeqIdstringOptional

productIdstringOptional

unitRecurringPricenumberOptional

autoCancelDatestring · dateOptional

isItemGroupPrimarystringOptional

productFeatureIdstringOptional

overrideGlAccountIdstringOptional

budgetIdstringOptional

taxCodestringOptional

supplierProductIdstringOptional

estimatedDeliveryDatestring · dateOptional

shipGroupSeqIdstringOptional

quoteIdstringOptional

requestedShipMethTypeIdstringOptional

availableToPromisenumberOptional

statusIdstringOptional

syncStatusIdstringOptional

requestedDeliveryDatestringOptional

estimatedShipDatestring · dateOptional

shoppingListItemSeqIdstringOptional

subscriptionIdstringOptional

salesOpportunityIdstringOptional

dontCancelSetUserLoginstringOptional

promisedDatetimestring · dateOptional

isModifiedPricestringOptional

isPromostringOptional

shipBeforeDatestring · dateOptional

productCategoryIdstringOptional

unitListPricenumberOptional

shoppingListIdstringOptional

unitAverageCostnumberOptional

orderItemTypeIdstringOptional

dontCancelSetDatestring · dateOptional

commentsstringOptional

quantitynumberOptional

recurringFreqUomIdstringOptional

orderItemGroupSeqIdstringOptional

quoteItemSeqIdstringOptional

fromInventoryItemIdstringOptional

externalIdstringOptional

budgetItemSeqIdstringOptional

correspondingPoIdstringOptional

cancelQuantitynumberOptional

shipAfterDatestring · dateOptional

deliveryWindownumberOptional

shipmentIdstringOptional

changeByUserLoginIdstringOptional

prodCatalogIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateAllOrderItems

Update a CarrierGeoMapping record

post

Update a CarrierGeoMapping record

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateCarrierGeoMapping request

geoNamestringOptional

geoTypeIdstringOptional

carrierPartyIdstringOptional

geoMapIdstringRequired

geoIdstringOptional

carrierGeoValuestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateCarrierGeoMapping

Updates A CarrierShipmentMethod

post

Updates A CarrierShipmentMethod

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateCarrierShipmentMethod request

sequenceNumberinteger · int32Optional

roleTypeIdstringRequired

deliveryDaysinteger · int32Optional

partyIdstringRequired

carrierServiceCodestringOptional

shipmentMethodTypeIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateCarrierShipmentMethod

update a DataManagerConfig

post

update a DataManagerConfig

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateDataManagerConfig 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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateDataManagerConfig

Update a DataManagerMapping

post

Update a DataManagerMapping

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateDataManagerMapping request

fromDatestring · dateOptional

mappingPrefNamestringOptional

mappingPrefTypeEnumIdstringOptional

mappingPrefIdstringRequired

mappingPrefValuestringOptional

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateDataManagerMapping

Update a Enumeration

post

Update a Enumeration

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateEnumeration request

enumTypeIdstringRequired

enumIdstringRequired

sequenceNuminteger · int32Optional

enumCodestringOptional

primaryEnumerationGroupIdstringOptional

descriptionstringRequired

enumNamestringOptional

sequenceIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateEnumeration

Update enumeration group member

post

Update enumeration group member

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateEnumerationGroupMember request

fromDatestring · dateRequired

enumerationIdstringRequired

sequenceNuminteger · int32Optional

enumerationGroupIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateEnumerationGroupMember

Bulk Update Facility -> Group Member

post

Bulk Update Facility -> Group Member

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilitiesToGroup request

payloadobjectRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilitiesToGroup

Update a Facility

post

Update a Facility

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacility request

facilityIdstringRequired

defaultInventoryItemTypeIdstringOptional

parentFacilityIdstringOptional

postalCodestringOptional

externalIdstringOptional

descriptionstringOptional

defaultWeightUomIdstringOptional

primaryFacilityGroupIdstringOptional

openedDatestring · dateOptional

ownerPartyIdstringOptional

facilityTimeZonestringOptional

facilitySizenumberOptional

closedDatestring · dateOptional

facilitySizeUomIdstringOptional

maximumOrderLimitinteger · int32Optional

closeTimestringOptional

defaultDaysToShipinteger · int32Optional

facilityTypeIdstringOptional

defaultDimensionUomIdstringOptional

productStoreIdstringOptional

facilityNamestringOptional

openTimestringOptional

geoPointIdstringOptional

oldSquareFootageinteger · int32Optional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacility

Update a FacilityContactMech

post

Update a FacilityContactMech

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityContactMech request

fromDatestring · dateOptional

extensionstringOptional

infoStringstringOptional

commentsstringOptional

facilityIdstringOptional

newContactMechIdstringOptional

contactMechTypeIdstringRequired

contactMechIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityContactMech

Update an Email Address

post

Update an Email Address

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityEmailAddress request

fromDatestring · dateOptional

emailAddressstringRequired

extensionstringOptional

commentsstringOptional

facilityIdstringOptional

contactMechIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityEmailAddress

Update a Facility Group

post

Update a Facility Group

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityGroup request

primaryParentGroupIdstringOptional

facilityGroupTypeIdstringOptional

facilityGroupIdstringRequired

descriptionstringOptional

facilityGroupNamestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityGroup

Update a FacilityIdentification

post

Update a FacilityIdentification

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityIdentification request

fromDatestring · dateRequired

facilityIdstringRequired

idValuestringOptional

facilityIdenTypeIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityIdentification

Update a Facility Location

post

Update a Facility Location

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityLocation request

nextCountDatestringOptional

lastCountDatestringOptional

areaIdstringOptional

facilityIdstringRequired

positionIdstringOptional

isLockedstringOptional

levelIdstringOptional

sectionIdstringOptional

geoPointIdstringOptional

locationTypeEnumIdstringOptional

aisleIdstringOptional

locationSeqIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityLocation

Update a Postal Address

post

Update a Postal Address

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityPostalAddress request

houseNumberExtstringOptional

extensionstringOptional

citystringOptional

latitudestringOptional

postalCodeGeoIdstringOptional

postalCodestringOptional

houseNumberinteger · int32Optional

postalCodeExtstringOptional

contactMechIdstringRequired

attnNamestringOptional

countyGeoIdstringOptional

toNamestringOptional

cityGeoIdstringOptional

longitudestringOptional

countryGeoIdstringOptional

commentsstringOptional

facilityIdstringOptional

address2stringOptional

address1stringOptional

encodedAddressKeystringOptional

thruDatestring · dateOptional

fromDatestring · dateOptional

directionsstringOptional

municipalityGeoIdstringOptional

stateProvinceGeoIdstringOptional

geoPointIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityPostalAddress

Update a Telecommunications Number

post

Update a Telecommunications Number

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityTelecomNumber request

fromDatestring · dateOptional

askForNamestringOptional

areaCodestringOptional

extensionstringOptional

commentsstringOptional

facilityIdstringOptional

countryCodestringOptional

contactNumberstringOptional

contactMechIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityTelecomNumber

Update Facility -> Group Member

post

Update Facility -> Group Member

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateFacilityToGroup request

fromDatestring · dateRequired

facilityIdstringRequired

sequenceNuminteger · int32Optional

facilityGroupIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateFacilityToGroup

Service to sync inventory from file provided by external systems

post

Service to sync inventory from file provided by external systems

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateInventoryByIdentification request

varianceReasonIdstringOptional

commentsstringOptional

idTypestringOptional

facilityIdstringOptional

idValuestringOptional

externalFacilityIdstringOptional

locationSeqIdstringOptional

availableDeltastringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateInventoryByIdentification

Update JobSandbox record

post

Update JobSandbox record

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateJobSandbox request

recurrenceInfoIdstringOptional

cancelDateTimestring · dateOptional

tempExprIdstringOptional

authUserLoginIdstringOptional

currentRetryCountinteger · int32Optional

runTimeEpochinteger · int32Optional

lastModifiedByUserLoginstringOptional

loaderNamestringOptional

shopIdstringOptional

productStoreIdstringOptional

runTimestring · dateOptional

createdByUserLoginstringOptional

jobNamestringOptional

runThreadstringOptional

runByInstanceIdstringOptional

maxRecurrenceCountinteger · int32Optional

currentRecurrenceCountinteger · int32Optional

serviceNamestringOptional

priorityinteger · int32Optional

runtimeDataIdstringOptional

finishDateTimestring · dateOptional

runAsUserstringOptional

maxRetryinteger · int32Optional

jobIdstringRequired

createdDatestring · dateOptional

startDateTimestring · dateOptional

statusIdstringOptional

previousJobIdstringOptional

parentJobIdstringOptional

jobResultstringOptional

poolIdstringOptional

systemJobEnumIdstringOptional

recurrenceTimeZonestringOptional

instanceOfProductIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateJobSandbox

Atomic updates OISGIR Solr document for rejected item.

post

Atomic updates OISGIR Solr document for rejected item.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOISGIRIFulfillmentStatus request

inventoryItemIdstringOptional

orderItemSeqIdstringOptional

orderIdstringOptional

shipGroupSeqIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOISGIRIFulfillmentStatus

This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity

post

This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderAddressAndAppendAttributes request

lookupFieldstringOptional

geoTypeIdstringOptional

orderIdstringOptional

attributesToAppendobjectOptional

fieldsToUpdatestring[]Optional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderAddressAndAppendAttributes

Update an OrderAttribute record

post

Update an OrderAttribute record

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderAttribute request

orderIdstringRequired

attrDescriptionstringOptional

attrValuestringOptional

attrNamestringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderAttribute

Update Order Item

post

Update Order Item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderItem request

requestedDeliveryTimestringOptional

orderIdstringRequired

isNewProductstringOptional

returnTillDatestring · dateOptional

deploymentIdstringOptional

cancelBackOrderDatestring · dateOptional

itemDescriptionstringOptional

selectedAmountnumberOptional

unitPricenumberOptional

orderItemSeqIdstringRequired

productIdstringOptional

unitRecurringPricenumberOptional

autoCancelDatestring · dateOptional

isItemGroupPrimarystringOptional

productFeatureIdstringOptional

overrideGlAccountIdstringOptional

budgetIdstringOptional

taxCodestringOptional

supplierProductIdstringOptional

estimatedDeliveryDatestring · dateOptional

shipGroupSeqIdstringOptional

quoteIdstringOptional

requestedShipMethTypeIdstringOptional

availableToPromisenumberOptional

statusIdstringOptional

syncStatusIdstringOptional

requestedDeliveryDatestringOptional

estimatedShipDatestring · dateOptional

shoppingListItemSeqIdstringOptional

subscriptionIdstringOptional

salesOpportunityIdstringOptional

dontCancelSetUserLoginstringOptional

promisedDatetimestring · dateOptional

isModifiedPricestringOptional

isPromostringOptional

shipBeforeDatestring · dateOptional

productCategoryIdstringOptional

unitListPricenumberOptional

shoppingListIdstringOptional

unitAverageCostnumberOptional

orderItemTypeIdstringOptional

dontCancelSetDatestring · dateOptional

commentsstringOptional

quantitynumberOptional

recurringFreqUomIdstringOptional

orderItemGroupSeqIdstringOptional

quoteItemSeqIdstringOptional

fromInventoryItemIdstringOptional

externalIdstringOptional

budgetItemSeqIdstringOptional

correspondingPoIdstringOptional

cancelQuantitynumberOptional

shipAfterDatestring · dateOptional

deliveryWindownumberOptional

shipmentIdstringOptional

changeByUserLoginIdstringOptional

prodCatalogIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderItem

Update Order Item Attribute

post

Update Order Item Attribute

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderItemAttribute request

orderItemSeqIdstringRequired

orderIdstringRequired

attrDescriptionstringOptional

attrValuestringOptional

attrNamestringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderItemAttribute

Sync Order Items (Shopify --> HC)

post

Sync Order Items (Shopify --> HC)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderItemFromShopify request

shopifyConfigIdstringRequired

payloadobjectOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderItemFromShopify

Updates OrderItemShipGroup. The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}

post

Updates OrderItemShipGroup. The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderItemShipGroup request

carrierServicestringOptional

facilityIdstringOptional

giftMessagestringOptional

orderIdstringRequired

shippingInstructionsstringOptional

shipByDatestring · dateOptional

maySplitstringOptional

estimatedDeliveryDatestring · dateOptional

shipGroupSeqIdstringRequired

contactMechIdstringOptional

vendorPartyIdstringOptional

shipAfterDatestring · dateOptional

telecomContactMechIdstringOptional

shipmentMethodstringOptional

carrierPartyIdstringOptional

contactMechPurposeTypeIdstringOptional

carrierRoleTypeIdstringOptional

oldContactMechIdstringOptional

estimatedShipDatestring · dateOptional

isGiftstringOptional

supplierPartyIdstringOptional

carrierAccountNumberstringOptional

trackingNumberstringOptional

shipmentMethodTypeIdstringOptional

orderFacilityIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderItemShipGroup

Update OrderPayemntPreference

post

Update OrderPayemntPreference

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateOrderPaymentPreferenceV2 request

cardNamestringOptional

orderIdstringOptional

manualAuthCodestringOptional

presentmentAmountnumberOptional

lastModifiedByUserLoginstringOptional

orderPaymentPreferenceIdstringRequired

exchangeRatenumberOptional

requestIdstringOptional

presentmentCurrencyUomstringOptional

paymentMethodIdstringOptional

overflowFlagstringOptional

maxAmountnumberOptional

productPricePurposeIdstringOptional

createdByUserLoginstringOptional

orderItemSeqIdstringOptional

track2stringOptional

paymentModestringOptional

lastModifiedDatestring · dateOptional

manualRefNumstringOptional

swipedFlagstringOptional

parentRefNumstringOptional

securityCodestringOptional

paymentMethodTypeIdstringOptional

applicationIdentifierstringOptional

shipGroupSeqIdstringOptional

processAttemptinteger · int32Optional

needsNsfRetrystringOptional

finAccountIdstringOptional

createdDatestring · dateOptional

statusIdstringOptional

billingPostalCodestringOptional

presentFlagstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateOrderPaymentPreferenceV2

Update a PartyGroup

post

Update a PartyGroup

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updatePartyGroup request

pdfLogoImageUrlstringOptional

commentsstringOptional

externalIdstringOptional

descriptionstringOptional

tickerSymbolstringOptional

logoImageUrlstringOptional

partyTypeIdstringOptional

groupNamestringOptional

groupNameLocalstringOptional

statusIdstringOptional

numEmployeesinteger · int32Optional

preferredCurrencyUomIdstringOptional

rankinginteger · int32Optional

partyIdstringOptional

annualRevenuenumberOptional

officeSiteNamestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updatePartyGroup

Update a Relationship between two Parties; if partyIdFrom is not specified the partyId of the current userLogin will be used; if roleTypeIds are not specified they will default to "_NA_". If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.

post

Update a Relationship between two Parties; if partyIdFrom is not specified the partyId of the current userLogin will be used; if roleTypeIds are not specified they will default to "NA". If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updatePartyRelationship request

roleTypeIdTostringOptional

partyIdFromstringOptional

commentsstringOptional

positionTitlestringOptional

permissionsEnumIdstringOptional

priorityTypeIdstringOptional

roleTypeIdFromstringOptional

thruDatestring · dateOptional

securityGroupIdstringOptional

relationshipNamestringOptional

fromDatestring · dateRequired

partyRelationshipTypeIdstringOptional

statusIdstringOptional

partyIdTostringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updatePartyRelationship

Update a Person

post

Update a Person

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updatePerson request

yearsWithEmployerinteger · int32Optional

lastNamestringOptional

occupationstringOptional

employmentStatusEnumIdstringOptional

genderstringOptional

socialSecurityNumberstringOptional

descriptionstringOptional

suffixstringOptional

mothersMaidenNamestringOptional

existingCustomerstringOptional

middleNameLocalstringOptional

residenceStatusEnumIdstringOptional

preferredCurrencyUomIdstringOptional

nicknamestringOptional

partyIdstringOptional

heightnumberOptional

memberIdstringOptional

passportNumberstringOptional

commentsstringOptional

lastNameLocalstringOptional

monthsWithEmployerinteger · int32Optional

externalIdstringOptional

weightnumberOptional

birthDatestringOptional

otherLocalstringOptional

firstNamestringRequired

anniversaryDatestringOptional

statusIdstringOptional

cardIdstringOptional

rankinginteger · int32Optional

passportExpireDatestringOptional

firstNameLocalstringOptional

middleNamestringOptional

salutationstringOptional

personalTitlestringOptional

totalYearsWorkExperiencenumberOptional

deceasedDatestringOptional

maritalStatusstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updatePerson

Update a PostalAddress.

post

Update a PostalAddress.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updatePostalAddressContactMech request

countryGeoIdstringOptional

houseNumberExtstringOptional

citystringOptional

address2stringOptional

address1stringOptional

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

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updatePostalAddressContactMech

Update a Product Store

post

Update a Product Store

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateProductStore request

requireCustomerRolestringOptional

viewCartOnAddstringOptional

companyNamestringOptional

headerDeclinedStatusstringOptional

requireInventorystringOptional

allowSplitstringOptional

autoApproveInvoicestringOptional

checkInventorystringOptional

addToCartRemoveIncompatstringOptional

enableAutoSuggestionListstringOptional

defaultSalesChannelEnumIdstringOptional

autoApproveOrderstringOptional

allowPasswordstringOptional

oldHeaderLogostringOptional

showTaxIsExemptstringOptional

enablePreOrderAutoReleasingstringOptional

autoSaveCartstringOptional

inventoryFacilityIdstringOptional

oldHeaderMiddleBackgroundstringOptional

headerApprovedStatusstringOptional

defaultTimeZoneStringstringOptional

oldStyleSheetstringOptional

showCheckoutGiftOptionsstringOptional

prorateTaxesstringOptional

itemDeclinedStatusstringOptional

manualAuthIsCapturestringOptional

storeDomainstringOptional

showOutOfStockProductsstringOptional

storeCreditAccountEnumIdstringOptional

itemApprovedStatusstringOptional

allowCommentstringOptional

splitPayPrefPerShpGrpstringOptional

storeCreditValidDaysinteger · int32Optional

managedByLotstringOptional

authFraudMessagestringOptional

reqShipAddrForDigItemsstringOptional

enableBrokeringstringOptional

oneInventoryFacilitystringOptional

autoSetFacilitystringOptional

autoInvoiceDigitalItemsstringOptional

orderNumberPrefixstringOptional

subtitlestringOptional

reserveOrderEnumIdstringOptional

productIdentifierEnumIdstringOptional

isDemoStorestringOptional

retryFailedAuthsstringOptional

selectPaymentTypePerItemstringOptional

enableExternalPromotionstringOptional

balanceResOnOrderCreationstringOptional

explodeOrderItemsstringOptional

autoApproveReviewsstringOptional

usePrimaryEmailUsernamestringOptional

termTypeIdstringOptional

restockingFeePercentagenumberOptional

headerCancelStatusstringOptional

titlestringOptional

primaryStoreGroupIdstringOptional

oldHeaderRightBackgroundstringOptional

enableDigProdUploadstringOptional

autoOrderCcTryOtherCardsstringOptional

autoOrderCcTryLaterMaxinteger · int32Optional

restockingFeeFixednumberOptional

digitalItemApprovedStatusstringOptional

reserveInventorystringOptional

storeNamestringOptional

ecomThemeIdstringOptional

productStoreIdstringRequired

storeLogoImageUrlstringOptional

isImmediatelyFulfilledstringOptional

defaultPasswordstringOptional

autoOrderCcTryExpstringOptional

itemCancelStatusstringOptional

authDeclinedMessagestringOptional

prodSearchExcludeVariantsstringOptional

shipIfCaptureFailsstringOptional

daysToReturninteger · int32Optional

catalogUrlMountPointstringOptional

showPricesWithVatTaxstringOptional

externalIdstringOptional

orderDecimalQuantitystringOptional

defaultCurrencyUomIdstringOptional

prorateShippingstringOptional

digProdUploadCategoryIdstringOptional

reqReturnInventoryReceivestringOptional

authErrorMessagestringOptional

setOwnerUponIssuancestringOptional

checkGcBalancestringOptional

addToCartReplaceUpsellstringOptional

autoOrderCcTryLaterNsfstringOptional

vatTaxAuthGeoIdstringOptional

capturePmntsOnOrdApprovalstringOptional

vatTaxAuthPartyIdstringOptional

daysToCancelNonPayinteger · int32Optional

requirementMethodEnumIdstringOptional

defaultLocaleStringstringOptional

payToPartyIdstringOptional

autoAcceptReturnstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateProductStore

Update a ProductStoreFacility

post

Update a ProductStoreFacility

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateProductStoreFacility request

fromDatestring · dateRequired

facilityIdstringRequired

sequenceNuminteger · int32Optional

productStoreIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateProductStoreFacility

Update a ProductStoreFacilityGroup

post

Update a ProductStoreFacilityGroup

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateProductStoreFacilityGroup request

fromDatestring · dateRequired

sequenceNumberinteger · int32Optional

facilityGroupIdstringRequired

productStoreIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateProductStoreFacilityGroup

Update a Product Store Role

post

Update a Product Store Role

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateProductStoreRole request

fromDatestring · dateRequired

roleTypeIdstringRequired

sequenceNuminteger · int32Optional

productStoreIdstringRequired

partyIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateProductStoreRole

Update a ProductStoreSetting

post

Update a ProductStoreSetting

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateProductStoreSetting request

settingValuestringOptional

productStoreIdstringRequired

settingTypeEnumIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateProductStoreSetting

Update a Product Store Shipment Method

post

Update 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: updateProductStoreShipMeth request

companyPartyIdstringOptional

productStoreShipMethIdstringRequired

allowancePercentnumberOptional

shipmentCustomMethodIdstringOptional

includeFeatureGroupstringOptional

minTotalnumberOptional

minWeightnumberOptional

requireCompanyAddrstringOptional

maxSizenumberOptional

excludeGeoIdstringOptional

isShippingWeightRequiredstringOptional

shipmentGatewayConfigIdstringOptional

minSizenumberOptional

allowCompanyAddrstringOptional

productStoreIdstringOptional

minimumPricenumberOptional

partyIdstringOptional

shipmentMethodTypeIdstringOptional

excludeFeatureGroupstringOptional

sequenceNumberinteger · int32Optional

roleTypeIdstringOptional

allowUspsAddrstringOptional

maxWeightnumberOptional

serviceNamestringOptional

thruDatestring · dateOptional

fromDatestring · dateOptional

includeGeoIdstringOptional

maxTotalnumberOptional

requireUspsAddrstringOptional

configPropsstringOptional

includeNoChargeItemsstringOptional

isTrackingRequiredstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateProductStoreShipMeth

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: updateSalesOrder request

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateSalesOrder

Update Search Preference

post

Update Search Preference

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateSearchPreference request

searchPrefNamestringOptional

isPublicstringOptional

searchPrefValuestringOptional

searchPrefIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateSearchPreference

Update a SecurityGroup

post

Update a SecurityGroup

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateSecurityGroup request

groupNamestringOptional

groupIdstringRequired

descriptionstringOptional

groupTypeEnumIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateSecurityGroup

Update a SecurityPermission from a SecurityGroup

post

Update a SecurityPermission from a SecurityGroup

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateSecurityPermissionToSecurityGroup request

fromDatestring · dateRequired

permissionIdstringRequired

groupIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateSecurityPermissionToSecurityGroup

Update Shipping Information on Order View

post

Update Shipping Information on Order View

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipGroupShipInfo request

shipmentMethodstringOptional

orderIdstringOptional

oldContactMechIdstringOptional

shipGroupSeqIdstringOptional

contactMechIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipGroupShipInfo

Update Shipment

post

Update Shipment

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipment request

statusDatestring · dateOptional

partyIdFromstringOptional

latestCancelDatestring · dateOptional

estimatedReadyDatestring · dateOptional

additionalShippingChargenumberOptional

estimatedArrivalWorkEffIdstringOptional

destinationTelecomNumberIdstringOptional

estimatedShipCostnumberOptional

shipmentMethodTypeIdstringOptional

destinationFacilityIdstringOptional

estimatedShipWorkEffIdstringOptional

addtlShippingChargeDescstringOptional

originContactMechIdstringOptional

externalIdstringOptional

primaryReturnIdstringOptional

originFacilityIdstringOptional

carrierPartyIdstringOptional

currencyUomIdstringOptional

destinationContactMechIdstringOptional

statusIdstringOptional

originTelecomNumberIdstringOptional

shipmentIdstringRequired

primaryOrderIdstringOptional

estimatedShipDatestring · dateOptional

partyIdTostringOptional

shipmentTypeIdstringOptional

estimatedArrivalDatestring · dateOptional

picklistBinIdstringOptional

primaryShipGroupSeqIdstringOptional

handlingInstructionsstringOptional

eventDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipment

Update a ShipmentBoxType record

post

Update a ShipmentBoxType record

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipmentBoxType request

boxLengthnumberOptional

boxWeightnumberOptional

dimensionUomIdstringOptional

weightUomIdstringOptional

descriptionstringOptional

boxHeightnumberOptional

boxWidthnumberOptional

shipmentBoxTypeIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipmentBoxType

Update ShipmentItem

post

Update ShipmentItem

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipmentItem request

availableToPromisenumberOptional

serialNumberstringOptional

quantitynumberOptional

productIdstringOptional

shipmentContentDescriptionstringOptional

shipmentIdstringRequired

externalIdstringOptional

shipmentItemSeqIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipmentItem

Updates A ShipmentMethodType

post

Updates A ShipmentMethodType

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipmentMethodType request

parentTypeIdstringOptional

sequenceNuminteger · int32Optional

descriptionstringOptional

shipmentMethodTypeIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipmentMethodType

Update ShipmentPackageRouteSeg

post

Update ShipmentPackageRouteSeg

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipmentPackageRouteSeg request

packagePickupPrnstringOptional

packageServiceCostnumberOptional

boxNumberstringOptional

trackingCodestringOptional

shipmentPackageSeqIdstringRequired

packageOtherCostnumberOptional

labelImageUrlstringOptional

shipmentRouteSegmentIdstringRequired

packagePickupDatestring · dateOptional

internationalInvoiceUrlstringOptional

currencyUomIdstringOptional

labelPrintedstringOptional

packageTransportCostnumberOptional

shipmentIdstringRequired

codAmountnumberOptional

insuredAmountnumberOptional

gatewayMessagestringOptional

gatewayStatusstringOptional

labelHtmlstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipmentPackageRouteSeg

Update ShipmentRouteSegment

post

Update ShipmentRouteSegment

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShipmentRouteSegment request

actualOtherCostnumberOptional

carrierDeliveryZonestringOptional

thirdPartyPostalCodestringOptional

destTelecomNumberIdstringOptional

carrierRestrictionCodesstringOptional

trackingIdNumberstringOptional

deliveryIdstringOptional

actualCarrierCodestringOptional

referenceNumberstringOptional

codCollectionAmountnumberOptional

actualStartDatestring · dateOptional

carrierServiceStatusIdstringOptional

trackingDigeststringOptional

shipmentMethodTypeIdstringOptional

actualCostnumberOptional

actualArrivalDatestring · dateOptional

carrierServicestringOptional

actualServiceCostnumberOptional

estimatedStartDatestring · dateOptional

originContactMechIdstringOptional

isGenerateThirdPartyLabelstringOptional

codReturnLabelHtmlstringOptional

actualTransportCostnumberOptional

carrierRestrictionDescstringOptional

billingWeightUomIdstringOptional

homeDeliveryDatestring · dateOptional

originFacilityIdstringOptional

carrierPartyIdstringOptional

destFacilityIdstringOptional

shipmentRouteSegmentIdstringRequired

lastUpdatedDatestring · dateOptional

currencyUomIdstringOptional

billingWeightnumberOptional

thirdPartyCountryGeoCodestringOptional

originTelecomNumberIdstringOptional

shipmentIdstringRequired

isTrackingRequiredstringOptional

thirdPartyAccountNumberstringOptional

homeDeliveryTypestringOptional

estimatedArrivalDatestring · dateOptional

destContactMechIdstringOptional

carrierAccountNumberstringOptional

updatedByUserLoginIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShipmentRouteSegment

This service create or update the party shipping address, updates shipping address of ShipGroup and its shipments and clears Online rates fetched for the shipment.

post

This service create or update the party shipping address, updates shipping address of ShipGroup and its shipments and clears Online rates fetched for the shipment.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShippingInformationOfShipGroup request

houseNumberExtstringOptional

orderIdstringRequired

citystringOptional

latitudestringOptional

postalCodeGeoIdstringOptional

postalCodestringOptional

houseNumberinteger · int32Optional

isEditedstringOptional

postalCodeExtstringOptional

contactMechIdstringOptional

shipmentMethodstringOptional

attnNamestringOptional

countyGeoIdstringOptional

toNamestringOptional

cityGeoIdstringOptional

partyIdstringOptional

longitudestringOptional

countryGeoIdstringOptional

keepLatitudeAndLongitudestringOptional

address2stringOptional

address1stringOptional

encodedAddressKeystringOptional

shipGroupSeqIdstringRequired

contactMechPurposeTypeIdstringOptional

directionsstringOptional

municipalityGeoIdstringOptional

stateProvinceGeoIdstringOptional

carrierAccountNumberstringOptional

geoPointIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShippingInformationOfShipGroup

Update Shopify draft order.

post

Update Shopify draft order.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShopifyDraftOrder request

shopifyConfigIdstringRequired

payloadobjectRequired

draftOrderIdinteger · int32Required

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShopifyDraftOrder

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: updateShopifyProdLocActivation request

shopifyLocationIdstringRequired

shopIdstringRequired

shopifyProductIdstringRequired

activatedstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShopifyProdLocActivation

Update a ShopifyShopCarrierShipment record

post

Update a ShopifyShopCarrierShipment record

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShopifyShopCarrierShipment request

carrierPartyIdstringOptional

shopifyShippingMethodstringRequired

shopIdstringRequired

shipmentMethodTypeIdstringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShopifyShopCarrierShipment

Update a ShopifyShopLocation record

post

Update a ShopifyShopLocation record

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateShopifyShopLocation request

facilityIdstringRequired

shopifyLocationIdstringOptional

shopIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateShopifyShopLocation

Update system property

post

Update system property

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateSystemProperty request

systemPropertyValuestringOptional

systemResourceIdstringRequired

descriptionstringOptional

systemPropertyIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateSystemProperty

First disable all userLogins, then enable the requested one.

post

First disable all userLogins, then enable the requested one.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateUserLoginStatus request

disabledDateTimestring · dateOptional

userLoginIdstringRequired

successiveFailedLoginsinteger · int32Optional

userLdapDnstringOptional

externalAuthIdstringOptional

requirePasswordChangestringOptional

partyIdstringRequired

enabledstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateUserLoginStatus

Update a UserLogin to SecurityGroup Appl

post

Update a UserLogin to SecurityGroup Appl

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateUserLoginToSecurityGroup request

fromDatestring · dateRequired

userLoginIdstringRequired

groupIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateUserLoginToSecurityGroup

Update Search Preference

post

Update Search Preference

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: updateUserSearchPreference request

fromDatestring · dateRequired

userLoginIdstringRequired

userSearchPrefTypeIdstringRequired

searchPrefIdstringRequired

thruDatestring · dateOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/updateUserSearchPreference

Upload And Import File

post

Upload And Import File

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: uploadAndImportFile request

scheduleNowbooleanOptional

fileProcessingDelayinteger · int32Optional

_uploadedFile_contentTypestringOptional

configIdstringRequired

createdByJobIdstringOptional

parametersobjectOptional

continueOnErrorbooleanOptional

_uploadedFile_fileNamestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/uploadAndImportFile

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: uploadPartyLogoImage request

contentUrlstringOptional

_uploadedFile_contentTypestringOptional

partyIdstringOptional

_uploadedFile_fileNamestringOptional

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/uploadPartyLogoImage

Main method to void shipping label from Third Party Shipping Services

post

Main method to void shipping label from Third Party Shipping Services

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

Content-TypestringRequiredExample: application/json

Body

In Schema for service: voidShipmentLabel request

shipmentIdstringRequired

Responses

200

Success response for the API call.

application/json

400

Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.

application/json

401

Unauthorized: Access is denied due to invalid or absent Authorization header.

application/json

403

Forbidden: Insufficient rights to perform this API call.

application/json

405

Method Not Allowed: Service called with HTTP method other than the declared one.

application/json

422

Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.

application/json

post

/services/voidShipmentLabel

PreviousAuthentication Token Generating Resource NextModels

Last updated 2 months ago

Was this helpful?