> For the complete documentation index, see [llms.txt](https://docs.hotwax.co/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hotwax.co/documents/integrate-with-hotwax/components/legacy-oms/exported-services.md).

# Exported Services

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

## Wrapper Service For Adding Category Products

> Wrapper Service For Adding Category Products

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addCategoryProducts":{"required":["productCategoryId","productId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"productCategoryId":{"type":"string"},"productId":{"type":"array","items":{"type":"string"}},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: addCategoryProducts request"},"api.response.addCategoryProducts.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addCategoryProducts response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addCategoryProducts":{"post":{"tags":["Exported Services"],"summary":"Wrapper Service For Adding Category Products","description":"Wrapper Service For Adding Category Products","operationId":"addCategoryProducts","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addCategoryProducts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addCategoryProducts"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addCategoryProducts.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for indexing data to Solr

> Service for indexing data to Solr

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addDataToSearchIndex":{"required":["coreName","data"],"type":"object","properties":{"updateHandler":{"type":"string"},"data":{"type":"array","items":{"type":"string"}},"coreName":{"type":"string"}},"description":"In Schema for service: addDataToSearchIndex request"},"api.response.addDataToSearchIndex.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addDataToSearchIndex response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addDataToSearchIndex":{"post":{"tags":["Exported Services"],"summary":"Service for indexing data to Solr","description":"Service for indexing data to Solr","operationId":"addDataToSearchIndex","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addDataToSearchIndex","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addDataToSearchIndex"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addDataToSearchIndex.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Bulk Add Facility To FacilityGroup

> Bulk Add Facility To FacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addFacilitiesToGroup":{"required":["payload"],"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: addFacilitiesToGroup request"},"api.response.addFacilitiesToGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addFacilitiesToGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addFacilitiesToGroup":{"post":{"tags":["Exported Services"],"summary":"Bulk Add Facility To FacilityGroup","description":"Bulk Add Facility To FacilityGroup","operationId":"addFacilitiesToGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addFacilitiesToGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addFacilitiesToGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addFacilitiesToGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Add Facility To FacilityGroup

> Add Facility To FacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addFacilityToGroup":{"required":["facilityGroupId","facilityId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"facilityGroupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: addFacilityToGroup request"},"api.response.addFacilityToGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addFacilityToGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addFacilityToGroup":{"post":{"tags":["Exported Services"],"summary":"Add Facility To FacilityGroup","description":"Add Facility To FacilityGroup","operationId":"addFacilityToGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addFacilityToGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addFacilityToGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addFacilityToGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a FacilityParty record

> Create a FacilityParty record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addPartyToFacility":{"required":["facilityId","partyId","roleTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"roleTypeId":{"type":"string"},"facilityId":{"type":"string"},"partyId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: addPartyToFacility request"},"api.response.addPartyToFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addPartyToFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addPartyToFacility":{"post":{"tags":["Exported Services"],"summary":"Create a FacilityParty record","description":"Create a FacilityParty record","operationId":"addPartyToFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addPartyToFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addPartyToFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addPartyToFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/addPartyUserPermission

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addPartyUserPermission":{"required":["groupIds","userLoginId"],"type":"object","properties":{"userLoginId":{"type":"string"},"groupIds":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: addPartyUserPermission request"},"api.response.addPartyUserPermission.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"userLoginId":{"type":"string"}}}},"description":"Out Schema for service: addPartyUserPermission response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addPartyUserPermission":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"addPartyUserPermission","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addPartyUserPermission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addPartyUserPermission"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addPartyUserPermission.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/addProductToFacility

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addProductToFacility":{"required":["facilityId","productId"],"type":"object","properties":{"allowPickup":{"type":"string"},"reorderPoint":{"type":"number"},"facilityId":{"type":"string"},"productId":{"type":"string"},"salesVelocity":{"type":"number"},"allowBrokering":{"type":"string"},"reorderQuantity":{"type":"number"},"inventoryItemId":{"type":"string"},"lastInventoryCount":{"type":"number"},"computedLastInventoryCount":{"type":"number"},"minimumStock":{"type":"number"},"requirementMethodEnumId":{"type":"string"},"maximumStock":{"type":"number"},"daysToShip":{"type":"integer","format":"int32"}},"description":"In Schema for service: addProductToFacility request"},"api.response.addProductToFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"productId":{"type":"string"}}}},"description":"Out Schema for service: addProductToFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addProductToFacility":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"addProductToFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addProductToFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addProductToFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addProductToFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/addSecurityGroupToUserLogin

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addSecurityGroupToUserLogin":{"required":["partyIdTo","securityGroupId"],"type":"object","properties":{"securityGroupId":{"type":"string"},"partyIdTo":{"type":"string"}},"description":"In Schema for service: addSecurityGroupToUserLogin request"},"api.response.addSecurityGroupToUserLogin.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addSecurityGroupToUserLogin response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addSecurityGroupToUserLogin":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"addSecurityGroupToUserLogin","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addSecurityGroupToUserLogin","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addSecurityGroupToUserLogin"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addSecurityGroupToUserLogin.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Add a SecurityPermission to a SecurityGroup

> Add a SecurityPermission to a SecurityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addSecurityPermissionToSecurityGroup":{"required":["fromDate","groupId","permissionId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"permissionId":{"type":"string"},"groupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: addSecurityPermissionToSecurityGroup request"},"api.response.addSecurityPermissionToSecurityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addSecurityPermissionToSecurityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addSecurityPermissionToSecurityGroup":{"post":{"tags":["Exported Services"],"summary":"Add a SecurityPermission to a SecurityGroup","description":"Add a SecurityPermission to a SecurityGroup","operationId":"addSecurityPermissionToSecurityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addSecurityPermissionToSecurityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addSecurityPermissionToSecurityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addSecurityPermissionToSecurityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items

> Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addShipmentPackage":{"required":["picklistBinId"],"type":"object","properties":{"carrierPartyId":{"type":"string"},"boxLength":{"type":"string"},"dimensionUomId":{"type":"string"},"boxNumber":{"type":"string"},"boxHeight":{"type":"string"},"boxWidth":{"type":"string"},"picklistBinId":{"type":"string"},"shipmentBoxTypeId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: addShipmentPackage request"},"api.response.addShipmentPackage.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipmentRouteSegmentId":{"type":"string"},"shipmentId":{"type":"string"},"shipmentPackageSeqId":{"type":"string"}}}},"description":"Out Schema for service: addShipmentPackage response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addShipmentPackage":{"post":{"tags":["Exported Services"],"summary":"Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items","description":"Create Shipment, ShipmentRouteSegment, ShipmentPackageRouteSeg and ShipmentPackage without items","operationId":"addShipmentPackage","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addShipmentPackage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addShipmentPackage"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addShipmentPackage.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Add a UserLogin to a SecurityGroup

> Add a UserLogin to a SecurityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.addUserLoginToSecurityGroup":{"required":["groupId","userLoginId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"userLoginId":{"type":"string"},"groupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: addUserLoginToSecurityGroup request"},"api.response.addUserLoginToSecurityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: addUserLoginToSecurityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/addUserLoginToSecurityGroup":{"post":{"tags":["Exported Services"],"summary":"Add a UserLogin to a SecurityGroup","description":"Add a UserLogin to a SecurityGroup","operationId":"addUserLoginToSecurityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service addUserLoginToSecurityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.addUserLoginToSecurityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.addUserLoginToSecurityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/allocateOrderItemToFacility

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.allocateOrderItemToFacility":{"required":["facilityId","orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"clearAutoCancelDate":{"type":"boolean"},"comments":{"type":"string"},"facilityId":{"type":"string"},"suggestedShipMethodTypeId":{"type":"string"},"orderId":{"type":"string"},"autoCancelDate":{"type":"string","format":"date"},"routingRuleId":{"type":"string"},"toShipGroupSeqId":{"type":"string"},"routingGroupId":{"type":"string"},"routingRule":{"type":"string"},"orderRoutingId":{"type":"string"},"changeReasonEnumId":{"type":"string"},"routingRunId":{"type":"string"}},"description":"In Schema for service: allocateOrderItemToFacility request"},"api.response.allocateOrderItemToFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"allocatedShipGroupSeqId":{"type":"string"}}}},"description":"Out Schema for service: allocateOrderItemToFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/allocateOrderItemToFacility":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"allocateOrderItemToFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service allocateOrderItemToFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.allocateOrderItemToFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.allocateOrderItemToFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Append an item to an existing order

> Append an item to an existing order

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.appendOrderItem":{"required":["orderId","productId","quantity","shipGroupSeqId"],"type":"object","properties":{"amount":{"type":"number"},"itemAttributesMap":{"type":"object"},"quantity":{"type":"number"},"productId":{"type":"string"},"orderId":{"type":"string"},"overridePrice":{"type":"string"},"autoCancelDate":{"type":"string","format":"date"},"offInvoicePrice":{"type":"number"},"disableResetGrandTotal":{"type":"boolean"},"quantityUomId":{"type":"string"},"shipAmount":{"type":"number"},"shipGroupSeqId":{"type":"string"},"surveyResponses":{"type":"array","items":{"type":"string"}},"unitListPrice":{"type":"number"},"changeComments":{"type":"string"},"calcTax":{"type":"boolean"},"discountMode":{"type":"string"},"itemDesiredDeliveryDate":{"type":"string","format":"date"},"reasonEnumId":{"type":"string"},"discountValue":{"type":"number"},"orderItemTypeId":{"type":"string"},"basePrice":{"type":"number"},"prodCatalogId":{"type":"string"}},"description":"In Schema for service: appendOrderItem request"},"api.response.appendOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"}}}},"description":"Out Schema for service: appendOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/appendOrderItem":{"post":{"tags":["Exported Services"],"summary":"Append an item to an existing order","description":"Append an item to an existing order","operationId":"appendOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service appendOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.appendOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.appendOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.approveSalesOrder":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"},"confirmApprove":{"type":"string"}},"description":"In Schema for service: approveSalesOrder request"},"api.response.approveSalesOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"oldStatusId":{"type":"string"},"orderStatusId":{"type":"string"},"statusId":{"type":"string"},"orderId":{"type":"string"}}}},"description":"Out Schema for service: approveSalesOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/approveSalesOrder":{"post":{"tags":["Exported Services"],"summary":"Change status of sales order to approved after validating certain checks which must be performed before approving order","description":"Change status of sales order to approved after validating certain checks which must be performed before approving order","operationId":"approveSalesOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service approveSalesOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.approveSalesOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.approveSalesOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Adjust Shopify inventory level.

> Adjust Shopify inventory level.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.bulkAdjustInventoryLevelOnShopify":{"required":["facilityId","shopifyConfigId"],"type":"object","properties":{"adjustInventoryList":{"type":"array","items":{"type":"string"}},"shopifyConfigId":{"type":"string"},"facilityId":{"type":"string"}},"description":"In Schema for service: bulkAdjustInventoryLevelOnShopify request"},"api.response.bulkAdjustInventoryLevelOnShopify.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: bulkAdjustInventoryLevelOnShopify response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/bulkAdjustInventoryLevelOnShopify":{"post":{"tags":["Exported Services"],"summary":"Adjust Shopify inventory level.","description":"Adjust Shopify inventory level.","operationId":"bulkAdjustInventoryLevelOnShopify","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service bulkAdjustInventoryLevelOnShopify","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.bulkAdjustInventoryLevelOnShopify"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.bulkAdjustInventoryLevelOnShopify.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Mark transfer order as Approved in bulk

> Mark transfer order as Approved in bulk

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.bulkApproveTransferOrders":{"type":"object","properties":{"bufferTime":{"type":"integer","format":"int32"},"orderIds":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: bulkApproveTransferOrders request"},"api.response.bulkApproveTransferOrders.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: bulkApproveTransferOrders response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/bulkApproveTransferOrders":{"post":{"tags":["Exported Services"],"summary":"Mark transfer order as Approved in bulk","description":"Mark transfer order as Approved in bulk","operationId":"bulkApproveTransferOrders","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service bulkApproveTransferOrders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.bulkApproveTransferOrders"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.bulkApproveTransferOrders.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Mark all orders items as picked in bulk

> Mark all orders items as picked in bulk

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.bulkPackStoreFulfillmentOrders":{"type":"object","properties":{"shipmentIds":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: bulkPackStoreFulfillmentOrders request"},"api.response.bulkPackStoreFulfillmentOrders.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipmentIds":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: bulkPackStoreFulfillmentOrders response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/bulkPackStoreFulfillmentOrders":{"post":{"tags":["Exported Services"],"summary":"Mark all orders items as picked in bulk","description":"Mark all orders items as picked in bulk","operationId":"bulkPackStoreFulfillmentOrders","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service bulkPackStoreFulfillmentOrders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.bulkPackStoreFulfillmentOrders"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.bulkPackStoreFulfillmentOrders.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Route all in progress orders to rebrokering

> Route all in progress orders to rebrokering

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.bulkRejectStoreInProgressOrders":{"required":["facilityId","productStoreId"],"type":"object","properties":{"facilityId":{"type":"string"},"reasonId":{"type":"string"},"productStoreId":{"type":"string"}},"description":"In Schema for service: bulkRejectStoreInProgressOrders request"},"api.response.bulkRejectStoreInProgressOrders.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: bulkRejectStoreInProgressOrders response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/bulkRejectStoreInProgressOrders":{"post":{"tags":["Exported Services"],"summary":"Route all in progress orders to rebrokering","description":"Route all in progress orders to rebrokering","operationId":"bulkRejectStoreInProgressOrders","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service bulkRejectStoreInProgressOrders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.bulkRejectStoreInProgressOrders"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.bulkRejectStoreInProgressOrders.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Route all outstanding orders to rebrokering

> Route all outstanding orders to rebrokering

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.bulkRejectStoreOutstandingOrders":{"required":["facilityId","productStoreId"],"type":"object","properties":{"facilityId":{"type":"string"},"reasonId":{"type":"string"},"productStoreId":{"type":"string"}},"description":"In Schema for service: bulkRejectStoreOutstandingOrders request"},"api.response.bulkRejectStoreOutstandingOrders.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: bulkRejectStoreOutstandingOrders response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/bulkRejectStoreOutstandingOrders":{"post":{"tags":["Exported Services"],"summary":"Route all outstanding orders to rebrokering","description":"Route all outstanding orders to rebrokering","operationId":"bulkRejectStoreOutstandingOrders","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service bulkRejectStoreOutstandingOrders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.bulkRejectStoreOutstandingOrders"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.bulkRejectStoreOutstandingOrders.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Mark shipments as Shipped in bulk

> Mark shipments as Shipped in bulk

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.bulkShipOrders":{"type":"object","properties":{"shipmentId":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: bulkShipOrders request"},"api.response.bulkShipOrders.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: bulkShipOrders response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/bulkShipOrders":{"post":{"tags":["Exported Services"],"summary":"Mark shipments as Shipped in bulk","description":"Mark shipments as Shipped in bulk","operationId":"bulkShipOrders","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service bulkShipOrders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.bulkShipOrders"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.bulkShipOrders.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a calendar and save calendar week details

> Create a calendar and save calendar week details

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.calendarDataSetup":{"type":"object","properties":{"sundayCapacity":{"type":"string"},"thursdayCapacity":{"type":"string"},"wednesdayStartTime":{"type":"string"},"wednesdayCapacity":{"type":"string"},"tuesdayStartTime":{"type":"string"},"fridayStartTime":{"type":"string"},"description":{"type":"string"},"saturdayCapacity":{"type":"string"},"mondayCapacity":{"type":"string"},"mondayStartTime":{"type":"string"},"calendarId":{"type":"string"},"saturdayStartTime":{"type":"string"},"thursdayStartTime":{"type":"string"},"sundayStartTime":{"type":"string"},"fridayCapacity":{"type":"string"},"tuesdayCapacity":{"type":"string"}},"description":"In Schema for service: calendarDataSetup request"},"api.response.calendarDataSetup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"calendarId":{"type":"string"}}}},"description":"Out Schema for service: calendarDataSetup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/calendarDataSetup":{"post":{"tags":["Exported Services"],"summary":"Create a calendar and save calendar week details","description":"Create a calendar and save calendar week details","operationId":"calendarDataSetup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service calendarDataSetup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.calendarDataSetup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.calendarDataSetup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Cancel an Order Item Quantity

> Cancel an Order Item Quantity

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.cancelOrderItem":{"required":["orderId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"itemReasonMap":{"type":"object"},"orderId":{"type":"string"},"itemCommentMap":{"type":"object"},"itemQtyMap":{"type":"object"},"shipGroupSeqId":{"type":"string"},"cancelQuantity":{"type":"number"}},"description":"In Schema for service: cancelOrderItem request"},"api.response.cancelOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: cancelOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/cancelOrderItem":{"post":{"tags":["Exported Services"],"summary":"Cancel an Order Item Quantity","description":"Cancel an Order Item Quantity","operationId":"cancelOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service cancelOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.cancelOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.cancelOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Cancel Order Item Quantity for order

> Cancel Order Item Quantity for order

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.cancelOrderItems":{"required":["orderId"],"type":"object","properties":{"itemReasonMap":{"type":"object"},"orderId":{"type":"string"},"cancelableItemMap":{"type":"object"},"shipGrpItemQtyMap":{"type":"object"}},"description":"In Schema for service: cancelOrderItems request"},"api.response.cancelOrderItems.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: cancelOrderItems response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/cancelOrderItems":{"post":{"tags":["Exported Services"],"summary":"Cancel Order Item Quantity for order","description":"Cancel Order Item Quantity for order","operationId":"cancelOrderItems","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service cancelOrderItems","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.cancelOrderItems"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.cancelOrderItems.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.cancelSalesOrder":{"required":["orderId"],"type":"object","properties":{"changeReason":{"type":"string"},"orderId":{"type":"string"}},"description":"In Schema for service: cancelSalesOrder request"},"api.response.cancelSalesOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: cancelSalesOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/cancelSalesOrder":{"post":{"tags":["Exported Services"],"summary":"checking whether fulfillment started for the order, if its not then order would be cancelled","description":"checking whether fulfillment started for the order, if its not then order would be cancelled","operationId":"cancelSalesOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service cancelSalesOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.cancelSalesOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.cancelSalesOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Cancels a schedule job

> Cancels a schedule job

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.cancelScheduledJob":{"required":["jobId"],"type":"object","properties":{"jobId":{"type":"string"}},"description":"In Schema for service: cancelScheduledJob request"},"api.response.cancelScheduledJob.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"statusId":{"type":"string"},"cancelDateTime":{"type":"string","format":"date"}}}},"description":"Out Schema for service: cancelScheduledJob response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/cancelScheduledJob":{"post":{"tags":["Exported Services"],"summary":"Cancels a schedule job","description":"Cancels a schedule job","operationId":"cancelScheduledJob","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service cancelScheduledJob","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.cancelScheduledJob"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.cancelScheduledJob.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.changeOrderItemStatus":{"required":["orderId","statusId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"changeReason":{"type":"string"},"statusId":{"type":"string"},"orderId":{"type":"string"},"statusDateTime":{"type":"string","format":"date"},"fromStatusId":{"type":"string"},"changeReasonEnumId":{"type":"string"}},"description":"In Schema for service: changeOrderItemStatus request"},"api.response.changeOrderItemStatus.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: changeOrderItemStatus response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/changeOrderItemStatus":{"post":{"tags":["Exported Services"],"summary":"Change the status of an existing order item.  If no orderItemSeqId is specified, the status of all order items will be changed.","description":"Change the status of an existing order item.  If no orderItemSeqId is specified, the status of all order items will be changed.","operationId":"changeOrderItemStatus","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service changeOrderItemStatus","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.changeOrderItemStatus"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.changeOrderItemStatus.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Change the status of an existing order

> Change the status of an existing order

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.changeOrderStatus":{"required":["orderId","statusId"],"type":"object","properties":{"setItemStatus":{"type":"string"},"changeReason":{"type":"string"},"statusId":{"type":"string"},"orderId":{"type":"string"},"changeReasonEnumId":{"type":"string"}},"description":"In Schema for service: changeOrderStatus request"},"api.response.changeOrderStatus.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"oldStatusId":{"type":"string"},"orderStatusId":{"type":"string"},"grandTotal":{"type":"number"},"orderTypeId":{"type":"string"},"needsInventoryIssuance":{"type":"string"}}}},"description":"Out Schema for service: changeOrderStatus response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/changeOrderStatus":{"post":{"tags":["Exported Services"],"summary":"Change the status of an existing order","description":"Change the status of an existing order","operationId":"changeOrderStatus","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service changeOrderStatus","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.changeOrderStatus"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.changeOrderStatus.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Check if fulfillment started for item and then reject it

> Check if fulfillment started for item and then reject it

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.checkAndRejectOrderItem":{"required":["orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"excludeOrderFacilityDuration":{"type":"string"},"orderId":{"type":"string"},"rejectionComments":{"type":"string"},"rejectionReason":{"type":"string"},"notify":{"type":"boolean"}},"description":"In Schema for service: checkAndRejectOrderItem request"},"api.response.checkAndRejectOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: checkAndRejectOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/checkAndRejectOrderItem":{"post":{"tags":["Exported Services"],"summary":"Check if fulfillment started for item and then reject it","description":"Check if fulfillment started for item and then reject it","operationId":"checkAndRejectOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service checkAndRejectOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.checkAndRejectOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.checkAndRejectOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.checkAttributesAndApproveOrder":{"type":"object","properties":{"orderId":{"type":"string"},"attributes":{"type":"object"}},"description":"In Schema for service: checkAttributesAndApproveOrder request"},"api.response.checkAttributesAndApproveOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderId":{"type":"string"}}}},"description":"Out Schema for service: checkAttributesAndApproveOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/checkAttributesAndApproveOrder":{"post":{"tags":["Exported Services"],"summary":"This service will check the list of attributes on the passed order and approve it if all the passed attributes are present","description":"This service will check the list of attributes on the passed order and approve it if all the passed attributes are present","operationId":"checkAttributesAndApproveOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service checkAttributesAndApproveOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.checkAttributesAndApproveOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.checkAttributesAndApproveOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.clearAllEntityCaches":{"type":"object","properties":{"distribute":{"type":"boolean"}},"description":"In Schema for service: clearAllEntityCaches request"},"api.response.clearAllEntityCaches.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: clearAllEntityCaches response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/clearAllEntityCaches":{"post":{"tags":["Exported Services"],"summary":"Clears all values from all Entity Engine caches. By default does not distribute.","description":"Clears all values from all Entity Engine caches. By default does not distribute.","operationId":"clearAllEntityCaches","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service clearAllEntityCaches","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.clearAllEntityCaches"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.clearAllEntityCaches.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.clearCacheLineByCondition":{"required":["entityName"],"type":"object","properties":{"entityName":{"type":"string"},"distribute":{"type":"boolean"}},"description":"In Schema for service: clearCacheLineByCondition request"},"api.response.clearCacheLineByCondition.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: clearCacheLineByCondition response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/clearCacheLineByCondition":{"post":{"tags":["Exported Services"],"summary":"Clear Cache Line with a condition; By default does not distribute.","description":"Clear Cache Line with a condition; By default does not distribute.","operationId":"clearCacheLineByCondition","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service clearCacheLineByCondition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.clearCacheLineByCondition"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.clearCacheLineByCondition.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Clear Cache Line with a dummyPK (GenericEntity); clears that all cache entry and depending on whether the dummyPK is a primaryKey or not this clears the by primary key cache or the specified entry in the by and cache. By default does not distribute.

> Clear Cache Line with a dummyPK (GenericEntity); clears that all cache entry and depending on whether the dummyPK is a primaryKey or not this clears the by primary key cache or the specified entry in the by and cache. By default does not distribute.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.clearCacheLineByDummyPK":{"type":"object","properties":{"distribute":{"type":"boolean"}},"description":"In Schema for service: clearCacheLineByDummyPK request"},"api.response.clearCacheLineByDummyPK.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: clearCacheLineByDummyPK response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/clearCacheLineByDummyPK":{"post":{"tags":["Exported Services"],"summary":"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.","description":"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.","operationId":"clearCacheLineByDummyPK","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service clearCacheLineByDummyPK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.clearCacheLineByDummyPK"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.clearCacheLineByDummyPK.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.clearCacheLineByPrimaryKey":{"required":["primaryKey"],"type":"object","properties":{"distribute":{"type":"boolean"},"primaryKey":{"type":"object"}},"description":"In Schema for service: clearCacheLineByPrimaryKey request"},"api.response.clearCacheLineByPrimaryKey.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: clearCacheLineByPrimaryKey response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/clearCacheLineByPrimaryKey":{"post":{"tags":["Exported Services"],"summary":"Clear Cache Line with a primaryKey (GenericPK); clears the all and by primary key caches. By default does not distribute.","description":"Clear Cache Line with a primaryKey (GenericPK); clears the all and by primary key caches. By default does not distribute.","operationId":"clearCacheLineByPrimaryKey","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service clearCacheLineByPrimaryKey","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.clearCacheLineByPrimaryKey"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.clearCacheLineByPrimaryKey.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Clear Cache Line with a value (GenericValue); this is the preferred method since the all, by primary key and by and caches will be cleared. By default does not distribute.

> Clear Cache Line with a value (GenericValue); this is the preferred method since the all, by primary key and by and caches will be cleared. By default does not distribute.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.clearCacheLineByValue":{"type":"object","properties":{"distribute":{"type":"boolean"}},"description":"In Schema for service: clearCacheLineByValue request"},"api.response.clearCacheLineByValue.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: clearCacheLineByValue response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/clearCacheLineByValue":{"post":{"tags":["Exported Services"],"summary":"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.","description":"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.","operationId":"clearCacheLineByValue","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service clearCacheLineByValue","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.clearCacheLineByValue"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.clearCacheLineByValue.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a new Carrier Shipment Box Type Record

> Create a new Carrier Shipment Box Type Record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createCarrierShipmentBoxType":{"required":["partyId","shipmentBoxTypeId"],"type":"object","properties":{"packagingTypeCode":{"type":"string"},"oversizeCode":{"type":"string"},"partyId":{"type":"string"},"shipmentBoxTypeId":{"type":"string"},"pickupContainerCode":{"type":"string"}},"description":"In Schema for service: createCarrierShipmentBoxType request"},"api.response.createCarrierShipmentBoxType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createCarrierShipmentBoxType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createCarrierShipmentBoxType":{"post":{"tags":["Exported Services"],"summary":"Create a new Carrier Shipment Box Type Record","description":"Create a new Carrier Shipment Box Type Record","operationId":"createCarrierShipmentBoxType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createCarrierShipmentBoxType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createCarrierShipmentBoxType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createCarrierShipmentBoxType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates A CarrierShipmentMethod

> Creates A CarrierShipmentMethod

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createCarrierShipmentMethod":{"required":["partyId","roleTypeId","shipmentMethodTypeId"],"type":"object","properties":{"sequenceNumber":{"type":"integer","format":"int32"},"roleTypeId":{"type":"string"},"deliveryDays":{"type":"integer","format":"int32"},"partyId":{"type":"string"},"carrierServiceCode":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: createCarrierShipmentMethod request"},"api.response.createCarrierShipmentMethod.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createCarrierShipmentMethod response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createCarrierShipmentMethod":{"post":{"tags":["Exported Services"],"summary":"Creates A CarrierShipmentMethod","description":"Creates A CarrierShipmentMethod","operationId":"createCarrierShipmentMethod","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createCarrierShipmentMethod","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createCarrierShipmentMethod"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createCarrierShipmentMethod.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/createCommercePartyRelationshipFrom

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createCommercePartyRelationshipFrom":{"required":["partyIdTo"],"type":"object","properties":{"roleTypeIdTo":{"type":"string"},"partyRelationshipTypeId":{"type":"string"},"partyIdFrom":{"type":"string"},"statusId":{"type":"string"},"partyIdTo":{"type":"string"},"roleTypeIdFrom":{"type":"string"}},"description":"In Schema for service: createCommercePartyRelationshipFrom request"},"api.response.createCommercePartyRelationshipFrom.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"partyId":{"type":"string"}}}},"description":"Out Schema for service: createCommercePartyRelationshipFrom response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createCommercePartyRelationshipFrom":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"createCommercePartyRelationshipFrom","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createCommercePartyRelationshipFrom","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createCommercePartyRelationshipFrom"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createCommercePartyRelationshipFrom.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Communication Event with permission check

> Create a Communication Event with permission check

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createCommunicationEvent":{"type":"object","properties":{"workEffortId":{"type":"string"},"note":{"type":"string"},"partyIdFrom":{"type":"string"},"orderId":{"type":"string"},"ccString":{"type":"string"},"subject":{"type":"string"},"contactMechTypeId":{"type":"string"},"communicationEventTypeId":{"type":"string"},"content":{"type":"string"},"contentMimeTypeId":{"type":"string"},"datetimeStarted":{"type":"string","format":"date"},"returnId":{"type":"string"},"contactListId":{"type":"string"},"action":{"type":"string"},"custRequestId":{"type":"string"},"contactMechIdFrom":{"type":"string"},"reasonEnumId":{"type":"string"},"roleTypeIdTo":{"type":"string"},"productId":{"type":"string"},"entryDate":{"type":"string","format":"date"},"parentCommEventId":{"type":"string"},"systemMessageRemoteId":{"type":"string"},"datetimeEnded":{"type":"string","format":"date"},"externalId":{"type":"string"},"messageId":{"type":"string"},"origCommEventId":{"type":"string"},"roleTypeIdFrom":{"type":"string"},"contactMechIdTo":{"type":"string"},"headerString":{"type":"string"},"statusId":{"type":"string"},"communicationEventId":{"type":"string"},"bccString":{"type":"string"},"toString":{"type":"string"},"partyIdTo":{"type":"string"},"fromString":{"type":"string"}},"description":"In Schema for service: createCommunicationEvent request"},"api.response.createCommunicationEvent.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"communicationEventId":{"type":"string"}}}},"description":"Out Schema for service: createCommunicationEvent response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createCommunicationEvent":{"post":{"tags":["Exported Services"],"summary":"Create a Communication Event with permission check","description":"Create a Communication Event with permission check","operationId":"createCommunicationEvent","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createCommunicationEvent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createCommunicationEvent"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createCommunicationEvent.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Communication Event Order

> Create a Communication Event Order

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createCommunicationEventOrder":{"required":["communicationEventId","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"communicationEventId":{"type":"string"}},"description":"In Schema for service: createCommunicationEventOrder request"},"api.response.createCommunicationEventOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createCommunicationEventOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createCommunicationEventOrder":{"post":{"tags":["Exported Services"],"summary":"Create a Communication Event Order","description":"Create a Communication Event Order","operationId":"createCommunicationEventOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createCommunicationEventOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createCommunicationEventOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createCommunicationEventOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a DataManagerConfig

> Create a DataManagerConfig

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createDataManagerConfig":{"type":"object","properties":{"importPath":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"exportServiceScreenName":{"type":"string"},"importServiceName":{"type":"string"},"fileNamePattern":{"type":"string"},"multiThreading":{"type":"string"},"description":{"type":"string"},"priority":{"type":"integer","format":"int32"},"exportPath":{"type":"string"},"exportContentId":{"type":"string"},"notifyOnFailure":{"type":"string"},"delimiter":{"type":"string"},"configId":{"type":"string"},"exportServiceName":{"type":"string"},"scriptTitle":{"type":"string"},"executionModeId":{"type":"string"}},"description":"In Schema for service: createDataManagerConfig request"},"api.response.createDataManagerConfig.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"configId":{"type":"string"}}}},"description":"Out Schema for service: createDataManagerConfig response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createDataManagerConfig":{"post":{"tags":["Exported Services"],"summary":"Create a DataManagerConfig","description":"Create a DataManagerConfig","operationId":"createDataManagerConfig","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createDataManagerConfig","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createDataManagerConfig"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createDataManagerConfig.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a DataManagerMapping

> Create a DataManagerMapping

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createDataManagerMapping":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"mappingPrefName":{"type":"string"},"mappingPrefTypeEnumId":{"type":"string"},"mappingPrefId":{"type":"string"},"mappingPrefValue":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createDataManagerMapping request"},"api.response.createDataManagerMapping.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"mappingPrefId":{"type":"string"}}}},"description":"Out Schema for service: createDataManagerMapping response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createDataManagerMapping":{"post":{"tags":["Exported Services"],"summary":"Create a DataManagerMapping","description":"Create a DataManagerMapping","operationId":"createDataManagerMapping","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createDataManagerMapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createDataManagerMapping"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createDataManagerMapping.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Enumeration

> Create a Enumeration

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createEnumeration":{"required":["description","enumTypeId"],"type":"object","properties":{"enumTypeId":{"type":"string"},"enumId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"enumCode":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"},"description":{"type":"string"},"enumName":{"type":"string"},"sequenceId":{"type":"string"}},"description":"In Schema for service: createEnumeration request"},"api.response.createEnumeration.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"enumId":{"type":"string"}}}},"description":"Out Schema for service: createEnumeration response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createEnumeration":{"post":{"tags":["Exported Services"],"summary":"Create a Enumeration","description":"Create a Enumeration","operationId":"createEnumeration","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createEnumeration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createEnumeration"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createEnumeration.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create enumeration group member

> Create enumeration group member

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createEnumerationGroupMember":{"required":["enumerationGroupId","enumerationId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"enumerationId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"enumerationGroupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createEnumerationGroupMember request"},"api.response.createEnumerationGroupMember.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createEnumerationGroupMember response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createEnumerationGroupMember":{"post":{"tags":["Exported Services"],"summary":"Create enumeration group member","description":"Create enumeration group member","operationId":"createEnumerationGroupMember","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createEnumerationGroupMember","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createEnumerationGroupMember"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createEnumerationGroupMember.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for create excluded order facility record for all order items

> Service for create excluded order facility record for all order items

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createExcludedOrderFacilityForOrder":{"type":"object","properties":{"externalOrderFacilityId":{"type":"string"},"orderId":{"type":"string"},"externalOrderId":{"type":"string"},"orderFacilityId":{"type":"string"}},"description":"In Schema for service: createExcludedOrderFacilityForOrder request"},"api.response.createExcludedOrderFacilityForOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createExcludedOrderFacilityForOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createExcludedOrderFacilityForOrder":{"post":{"tags":["Exported Services"],"summary":"Service for create excluded order facility record for all order items","description":"Service for create excluded order facility record for all order items","operationId":"createExcludedOrderFacilityForOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createExcludedOrderFacilityForOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createExcludedOrderFacilityForOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createExcludedOrderFacilityForOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Facility

> Create a Facility

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacility":{"required":["facilityName","facilityTypeId","ownerPartyId"],"type":"object","properties":{"facilityId":{"type":"string"},"defaultInventoryItemTypeId":{"type":"string"},"parentFacilityId":{"type":"string"},"postalCode":{"type":"string"},"externalId":{"type":"string"},"description":{"type":"string"},"defaultWeightUomId":{"type":"string"},"primaryFacilityGroupId":{"type":"string"},"openedDate":{"type":"string","format":"date"},"ownerPartyId":{"type":"string"},"facilityTimeZone":{"type":"string"},"facilitySize":{"type":"number"},"closedDate":{"type":"string","format":"date"},"facilitySizeUomId":{"type":"string"},"maximumOrderLimit":{"type":"integer","format":"int32"},"closeTime":{"type":"string"},"defaultDaysToShip":{"type":"integer","format":"int32"},"facilityTypeId":{"type":"string"},"defaultDimensionUomId":{"type":"string"},"productStoreId":{"type":"string"},"facilityName":{"type":"string"},"openTime":{"type":"string"},"geoPointId":{"type":"string"},"oldSquareFootage":{"type":"integer","format":"int32"}},"description":"In Schema for service: createFacility request"},"api.response.createFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"facilityId":{"type":"string"}}}},"description":"Out Schema for service: createFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacility":{"post":{"tags":["Exported Services"],"summary":"Create a Facility","description":"Create a Facility","operationId":"createFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a FacilityCalendar

> Create a FacilityCalendar

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityCalendar":{"required":["calendarId","facilityCalendarTypeId","facilityId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"calendarId":{"type":"string"},"facilityCalendarTypeId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createFacilityCalendar request"},"api.response.createFacilityCalendar.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createFacilityCalendar response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityCalendar":{"post":{"tags":["Exported Services"],"summary":"Create a FacilityCalendar","description":"Create a FacilityCalendar","operationId":"createFacilityCalendar","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityCalendar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityCalendar"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityCalendar.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a FacilityContactMech

> Create a FacilityContactMech

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityContactMech":{"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"extension":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"infoString":{"type":"string"},"contactMechPurposeTypeId":{"type":"string"},"externalId":{"type":"string"},"contactMechTypeId":{"type":"string"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createFacilityContactMech request"},"api.response.createFacilityContactMech.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createFacilityContactMech response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityContactMech":{"post":{"tags":["Exported Services"],"summary":"Create a FacilityContactMech","description":"Create a FacilityContactMech","operationId":"createFacilityContactMech","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityContactMech","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityContactMech"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityContactMech.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create an Email Address

> Create an Email Address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityEmailAddress":{"required":["emailAddress"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"emailAddress":{"type":"string"},"extension":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"infoString":{"type":"string"},"contactMechPurposeTypeId":{"type":"string"},"externalId":{"type":"string"},"contactMechTypeId":{"type":"string"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createFacilityEmailAddress request"},"api.response.createFacilityEmailAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createFacilityEmailAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityEmailAddress":{"post":{"tags":["Exported Services"],"summary":"Create an Email Address","description":"Create an Email Address","operationId":"createFacilityEmailAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityEmailAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityEmailAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityEmailAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Facility Group

> Create a Facility Group

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityGroup":{"required":["facilityGroupName","facilityGroupTypeId"],"type":"object","properties":{"primaryParentGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"facilityGroupId":{"type":"string"},"description":{"type":"string"},"facilityGroupName":{"type":"string"}},"description":"In Schema for service: createFacilityGroup request"},"api.response.createFacilityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"facilityGroupId":{"type":"string"}}}},"description":"Out Schema for service: createFacilityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityGroup":{"post":{"tags":["Exported Services"],"summary":"Create a Facility Group","description":"Create a Facility Group","operationId":"createFacilityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a FacilityIdentification

> Create a FacilityIdentification

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityIdentification":{"required":["facilityId","facilityIdenTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"idValue":{"type":"string"},"facilityIdenTypeId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createFacilityIdentification request"},"api.response.createFacilityIdentification.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createFacilityIdentification response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityIdentification":{"post":{"tags":["Exported Services"],"summary":"Create a FacilityIdentification","description":"Create a FacilityIdentification","operationId":"createFacilityIdentification","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityIdentification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityIdentification"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityIdentification.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Facility Location

> Create a Facility Location

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityLocation":{"required":["facilityId"],"type":"object","properties":{"nextCountDate":{"type":"string"},"lastCountDate":{"type":"string"},"facilityId":{"type":"string"},"areaId":{"type":"string"},"positionId":{"type":"string"},"isLocked":{"type":"string"},"levelId":{"type":"string"},"sectionId":{"type":"string"},"geoPointId":{"type":"string"},"locationTypeEnumId":{"type":"string"},"aisleId":{"type":"string"}},"description":"In Schema for service: createFacilityLocation request"},"api.response.createFacilityLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"locationSeqId":{"type":"string"}}}},"description":"Out Schema for service: createFacilityLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityLocation":{"post":{"tags":["Exported Services"],"summary":"Create a Facility Location","description":"Create a Facility Location","operationId":"createFacilityLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Postal Address

> Create a Postal Address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityPostalAddress":{"required":["address1","city","contactMechId"],"type":"object","properties":{"houseNumberExt":{"type":"string"},"extension":{"type":"string"},"city":{"type":"string"},"latitude":{"type":"string"},"postalCodeGeoId":{"type":"string"},"postalCode":{"type":"string"},"houseNumber":{"type":"integer","format":"int32"},"postalCodeExt":{"type":"string"},"contactMechId":{"type":"string"},"attnName":{"type":"string"},"countyGeoId":{"type":"string"},"toName":{"type":"string"},"paymentMethodId":{"type":"string"},"cityGeoId":{"type":"string"},"longitude":{"type":"string"},"countryGeoId":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"address2":{"type":"string"},"address1":{"type":"string"},"encodedAddressKey":{"type":"string"},"thruDate":{"type":"string","format":"date"},"fromDate":{"type":"string","format":"date"},"contactMechPurposeTypeId":{"type":"string"},"directions":{"type":"string"},"municipalityGeoId":{"type":"string"},"stateProvinceGeoId":{"type":"string"},"geoPointId":{"type":"string"}},"description":"In Schema for service: createFacilityPostalAddress request"},"api.response.createFacilityPostalAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createFacilityPostalAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityPostalAddress":{"post":{"tags":["Exported Services"],"summary":"Create a Postal Address","description":"Create a Postal Address","operationId":"createFacilityPostalAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityPostalAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityPostalAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityPostalAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Telecommunications Number

> Create a Telecommunications Number

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createFacilityTelecomNumber":{"required":["contactMechId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"askForName":{"type":"string"},"areaCode":{"type":"string"},"extension":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"contactMechPurposeTypeId":{"type":"string"},"countryCode":{"type":"string"},"contactNumber":{"type":"string"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createFacilityTelecomNumber request"},"api.response.createFacilityTelecomNumber.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createFacilityTelecomNumber response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createFacilityTelecomNumber":{"post":{"tags":["Exported Services"],"summary":"Create a Telecommunications Number","description":"Create a Telecommunications Number","operationId":"createFacilityTelecomNumber","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createFacilityTelecomNumber","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createFacilityTelecomNumber"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createFacilityTelecomNumber.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates the fulfillment log

> Creates the fulfillment log

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createGcFulFillmentRecord":{"required":["typeEnumId"],"type":"object","properties":{"referenceNum":{"type":"string"},"orderItemSeqId":{"type":"string"},"amount":{"type":"number"},"authCode":{"type":"string"},"orderId":{"type":"string"},"merchantId":{"type":"string"},"pinNumber":{"type":"string"},"typeEnumId":{"type":"string"},"surveyResponseId":{"type":"string"},"partyId":{"type":"string"},"cardNumber":{"type":"string"},"responseCode":{"type":"string"}},"description":"In Schema for service: createGcFulFillmentRecord request"},"api.response.createGcFulFillmentRecord.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createGcFulFillmentRecord response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createGcFulFillmentRecord":{"post":{"tags":["Exported Services"],"summary":"Creates the fulfillment log","description":"Creates the fulfillment log","operationId":"createGcFulFillmentRecord","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createGcFulFillmentRecord","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createGcFulFillmentRecord"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createGcFulFillmentRecord.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Shopify Return in HC

> Create Shopify Return in HC

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createIncomingShipment":{"required":["payload"],"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: createIncomingShipment request"},"api.response.createIncomingShipment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipmentId":{"type":"string"}}}},"description":"Out Schema for service: createIncomingShipment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createIncomingShipment":{"post":{"tags":["Exported Services"],"summary":"Create Shopify Return in HC","description":"Create Shopify Return in HC","operationId":"createIncomingShipment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createIncomingShipment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createIncomingShipment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createIncomingShipment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createNewUserLoginAndSetUserPreference":{"required":["currentPassword","currentPasswordVerify","userLoginId","userPrefTypeId"],"type":"object","properties":{"userLoginId":{"type":"string"},"userPrefGroupTypeId":{"type":"string"},"passwordHint":{"type":"string"},"userPrefValue":{"type":"string"},"currentPasswordVerify":{"type":"string"},"externalAuthId":{"type":"string"},"requirePasswordChange":{"type":"string"},"userPrefTypeId":{"type":"string"},"partyId":{"type":"string"},"userPrefLoginId":{"type":"string"},"enabled":{"type":"string"},"currentPassword":{"type":"string"}},"description":"In Schema for service: createNewUserLoginAndSetUserPreference request"},"api.response.createNewUserLoginAndSetUserPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"currentCompany":{"type":"object"},"userPrefValue":{"type":"string"}}}},"description":"Out Schema for service: createNewUserLoginAndSetUserPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createNewUserLoginAndSetUserPreference":{"post":{"tags":["Exported Services"],"summary":"Creates a New User Login and Set it's default Organization by creating User Preference entity record.","description":"Creates a New User Login and Set it's default Organization by creating User Preference entity record.","operationId":"createNewUserLoginAndSetUserPreference","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createNewUserLoginAndSetUserPreference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createNewUserLoginAndSetUserPreference"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createNewUserLoginAndSetUserPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for creating the index for a single OISGIR.

> Service for creating the index for a single OISGIR.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createOISGIRIndex":{"type":"object","properties":{"inventoryItemId":{"type":"string"},"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"shipmentId":{"type":"string"},"tenantId":{"type":"string"},"shipGroupSeqId":{"type":"string"}},"description":"In Schema for service: createOISGIRIndex request"},"api.response.createOISGIRIndex.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createOISGIRIndex response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createOISGIRIndex":{"post":{"tags":["Exported Services"],"summary":"Service for creating the index for a single OISGIR.","description":"Service for creating the index for a single OISGIR.","operationId":"createOISGIRIndex","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createOISGIRIndex","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createOISGIRIndex"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createOISGIRIndex.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service to create order appeasement

> Service to create order appeasement

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createOrderAppeasement":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"},"appeasementAmount":{"type":"number"},"itemAmountMap":{"type":"object"}},"description":"In Schema for service: createOrderAppeasement request"},"api.response.createOrderAppeasement.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"returnId":{"type":"string"}}}},"description":"Out Schema for service: createOrderAppeasement response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createOrderAppeasement":{"post":{"tags":["Exported Services"],"summary":"Service to create order appeasement","description":"Service to create order appeasement","operationId":"createOrderAppeasement","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createOrderAppeasement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createOrderAppeasement"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createOrderAppeasement.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create an OrderAttribute record

> Create an OrderAttribute record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createOrderAttribute":{"required":["attrName","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"attrDescription":{"type":"string"},"attrValue":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: createOrderAttribute request"},"api.response.createOrderAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createOrderAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createOrderAttribute":{"post":{"tags":["Exported Services"],"summary":"Create an OrderAttribute record","description":"Create an OrderAttribute record","operationId":"createOrderAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createOrderAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createOrderAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createOrderAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Order Indexes

> Create Order Indexes

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createOrderIndex":{"required":["orderId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"tenantId":{"type":"string"}},"description":"In Schema for service: createOrderIndex request"},"api.response.createOrderIndex.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createOrderIndex response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createOrderIndex":{"post":{"tags":["Exported Services"],"summary":"Create Order Indexes","description":"Create Order Indexes","operationId":"createOrderIndex","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createOrderIndex","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createOrderIndex"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createOrderIndex.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Order Item Attribute

> Create Order Item Attribute

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createOrderItemAttribute":{"required":["attrName","orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"attrDescription":{"type":"string"},"attrValue":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: createOrderItemAttribute request"},"api.response.createOrderItemAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createOrderItemAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createOrderItemAttribute":{"post":{"tags":["Exported Services"],"summary":"Create Order Item Attribute","description":"Create Order Item Attribute","operationId":"createOrderItemAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createOrderItemAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createOrderItemAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createOrderItemAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a PartyGroup

> Create a PartyGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createPartyGroup":{"required":["groupName"],"type":"object","properties":{"pdfLogoImageUrl":{"type":"string"},"comments":{"type":"string"},"externalId":{"type":"string"},"description":{"type":"string"},"tickerSymbol":{"type":"string"},"logoImageUrl":{"type":"string"},"partyTypeId":{"type":"string"},"groupName":{"type":"string"},"groupNameLocal":{"type":"string"},"statusId":{"type":"string"},"numEmployees":{"type":"integer","format":"int32"},"preferredCurrencyUomId":{"type":"string"},"ranking":{"type":"integer","format":"int32"},"partyId":{"type":"string"},"annualRevenue":{"type":"number"},"officeSiteName":{"type":"string"}},"description":"In Schema for service: createPartyGroup request"},"api.response.createPartyGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"partyId":{"type":"string"}}}},"description":"Out Schema for service: createPartyGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createPartyGroup":{"post":{"tags":["Exported Services"],"summary":"Create a PartyGroup","description":"Create a PartyGroup","operationId":"createPartyGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createPartyGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createPartyGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createPartyGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Postal Address

> Create a Postal Address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createPostalAddress":{"required":["address1","city","contactMechId"],"type":"object","properties":{"countryGeoId":{"type":"string"},"houseNumberExt":{"type":"string"},"city":{"type":"string"},"address2":{"type":"string"},"address1":{"type":"string"},"latitude":{"type":"number"},"postalCodeGeoId":{"type":"string"},"postalCode":{"type":"string"},"encodedAddressKey":{"type":"string"},"houseNumber":{"type":"integer","format":"int32"},"postalCodeExt":{"type":"string"},"contactMechId":{"type":"string"},"attnName":{"type":"string"},"countyGeoId":{"type":"string"},"directions":{"type":"string"},"toName":{"type":"string"},"cityGeoId":{"type":"string"},"municipalityGeoId":{"type":"string"},"stateProvinceGeoId":{"type":"string"},"geoPointId":{"type":"string"},"longitude":{"type":"number"}},"description":"In Schema for service: createPostalAddress request"},"api.response.createPostalAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createPostalAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createPostalAddress":{"post":{"tags":["Exported Services"],"summary":"Create a Postal Address","description":"Create a Postal Address","operationId":"createPostalAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createPostalAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createPostalAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createPostalAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create an ProductFacilityLocation

> Create an ProductFacilityLocation

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductFacilityLocation":{"required":["facilityId","locationSeqId","productId"],"type":"object","properties":{"facilityId":{"type":"string"},"productId":{"type":"string"},"moveQuantity":{"type":"number"},"minimumStock":{"type":"number"},"maximumStock":{"type":"number"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: createProductFacilityLocation request"},"api.response.createProductFacilityLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createProductFacilityLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductFacilityLocation":{"post":{"tags":["Exported Services"],"summary":"Create an ProductFacilityLocation","description":"Create an ProductFacilityLocation","operationId":"createProductFacilityLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductFacilityLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductFacilityLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductFacilityLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Index for single product.

> Create Index for single product.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductIndex":{"type":"object","properties":{"productId":{"type":"string"},"indexVariants":{"type":"boolean"},"tenantId":{"type":"string"}},"description":"In Schema for service: createProductIndex request"},"api.response.createProductIndex.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createProductIndex response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductIndex":{"post":{"tags":["Exported Services"],"summary":"Create Index for single product.","description":"Create Index for single product.","operationId":"createProductIndex","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductIndex","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductIndex"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductIndex.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a ProductStoreFacility

> Create a ProductStoreFacility

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductStoreFacility":{"required":["facilityId","fromDate","productStoreId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"productStoreId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createProductStoreFacility request"},"api.response.createProductStoreFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createProductStoreFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductStoreFacility":{"post":{"tags":["Exported Services"],"summary":"Create a ProductStoreFacility","description":"Create a ProductStoreFacility","operationId":"createProductStoreFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductStoreFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductStoreFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductStoreFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a ProductStoreFacilityGroup

> Create a ProductStoreFacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductStoreFacilityGroup":{"required":["facilityGroupId","fromDate","productStoreId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"sequenceNumber":{"type":"integer","format":"int32"},"facilityGroupId":{"type":"string"},"productStoreId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createProductStoreFacilityGroup request"},"api.response.createProductStoreFacilityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createProductStoreFacilityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductStoreFacilityGroup":{"post":{"tags":["Exported Services"],"summary":"Create a ProductStoreFacilityGroup","description":"Create a ProductStoreFacilityGroup","operationId":"createProductStoreFacilityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductStoreFacilityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductStoreFacilityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductStoreFacilityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create ProductStoreRole

> Create ProductStoreRole

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductStoreRole":{"required":["partyId","productStoreId","roleTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"roleTypeId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"productStoreId":{"type":"string"},"partyId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: createProductStoreRole request"},"api.response.createProductStoreRole.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createProductStoreRole response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductStoreRole":{"post":{"tags":["Exported Services"],"summary":"Create ProductStoreRole","description":"Create ProductStoreRole","operationId":"createProductStoreRole","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductStoreRole","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductStoreRole"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductStoreRole.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a ProductStoreSetting

> Create a ProductStoreSetting

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductStoreSetting":{"required":["productStoreId","settingTypeEnumId"],"type":"object","properties":{"settingValue":{"type":"string"},"productStoreId":{"type":"string"},"settingTypeEnumId":{"type":"string"}},"description":"In Schema for service: createProductStoreSetting request"},"api.response.createProductStoreSetting.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createProductStoreSetting response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductStoreSetting":{"post":{"tags":["Exported Services"],"summary":"Create a ProductStoreSetting","description":"Create a ProductStoreSetting","operationId":"createProductStoreSetting","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductStoreSetting","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductStoreSetting"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductStoreSetting.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a Product Store Shipment Method

> Create a Product Store Shipment Method

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createProductStoreShipMeth":{"required":["partyId","productStoreId","productStoreShipMethId","roleTypeId","shipmentMethodTypeId"],"type":"object","properties":{"companyPartyId":{"type":"string"},"productStoreShipMethId":{"type":"string"},"allowancePercent":{"type":"number"},"shipmentCustomMethodId":{"type":"string"},"includeFeatureGroup":{"type":"string"},"minTotal":{"type":"number"},"minWeight":{"type":"number"},"requireCompanyAddr":{"type":"string"},"maxSize":{"type":"number"},"excludeGeoId":{"type":"string"},"isShippingWeightRequired":{"type":"string"},"shipmentGatewayConfigId":{"type":"string"},"minSize":{"type":"number"},"allowCompanyAddr":{"type":"string"},"productStoreId":{"type":"string"},"minimumPrice":{"type":"number"},"partyId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"excludeFeatureGroup":{"type":"string"},"sequenceNumber":{"type":"integer","format":"int32"},"roleTypeId":{"type":"string"},"allowUspsAddr":{"type":"string"},"maxWeight":{"type":"number"},"serviceName":{"type":"string"},"thruDate":{"type":"string","format":"date"},"fromDate":{"type":"string","format":"date"},"includeGeoId":{"type":"string"},"maxTotal":{"type":"number"},"requireUspsAddr":{"type":"string"},"configProps":{"type":"string"},"includeNoChargeItems":{"type":"string"},"isTrackingRequired":{"type":"string"}},"description":"In Schema for service: createProductStoreShipMeth request"},"api.response.createProductStoreShipMeth.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"productStoreShipMethId":{"type":"string"}}}},"description":"Out Schema for service: createProductStoreShipMeth response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createProductStoreShipMeth":{"post":{"tags":["Exported Services"],"summary":"Create a Product Store Shipment Method","description":"Create a Product Store Shipment Method","operationId":"createProductStoreShipMeth","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createProductStoreShipMeth","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createProductStoreShipMeth"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createProductStoreShipMeth.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/createPurchaseShipment

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createPurchaseShipment":{"required":["facilityId","orderId"],"type":"object","properties":{"facilityId":{"type":"string"},"orderId":{"type":"string"},"shipGroupSeqId":{"type":"string"}},"description":"In Schema for service: createPurchaseShipment request"},"api.response.createPurchaseShipment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipmentId":{"type":"string"}}}},"description":"Out Schema for service: createPurchaseShipment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createPurchaseShipment":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"createPurchaseShipment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createPurchaseShipment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createPurchaseShipment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createPurchaseShipment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Relationship record

> Create Relationship record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createRelationship":{"required":["partyTypeId"],"type":"object","properties":{"roleTypeIdTo":{"type":"string"},"partyIdFrom":{"type":"string"},"lastName":{"type":"string"},"extension":{"type":"string"},"phoneContactMechPurpose":{"type":"string"},"externalId":{"type":"string"},"roleTypeIdFrom":{"type":"string"},"thruDate":{"type":"string","format":"date"},"fromDate":{"type":"string","format":"date"},"partyRelationshipTypeId":{"type":"string"},"firstName":{"type":"string"},"partyTypeId":{"type":"string"},"emailAddress":{"type":"string"},"groupName":{"type":"string"},"statusId":{"type":"string"},"preferredCurrencyUomId":{"type":"string"},"emailContactMechPurpose":{"type":"string"},"contactNumber":{"type":"string"}},"description":"In Schema for service: createRelationship request"},"api.response.createRelationship.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"partyId":{"type":"string"}}}},"description":"Out Schema for service: createRelationship response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createRelationship":{"post":{"tags":["Exported Services"],"summary":"Create Relationship record","description":"Create Relationship record","operationId":"createRelationship","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createRelationship","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createRelationship"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createRelationship.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create return/sales return based on API input parameters

> Create return/sales return based on API input parameters

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createReturn":{"required":["payLoad"],"type":"object","properties":{"payLoad":{"title":"The Root Schema","required":["type"],"type":"object","properties":{"externalId":{"title":"The Externalid Schema","type":"string"},"note":{"title":"The Return Note Schema","type":"string"},"returnPaymentPref":{"title":"The Return Payment Preference Schema","type":"array","items":{"title":"The Return Payment Pref item Schema","required":["paymentMethodTypeId","statusId"],"type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"paymentMethodTypeId":{"title":"The PaymentMethodTypeId Schema","type":"string"},"statusId":{"title":"The StatusId Schema","type":"string"},"manualRefNum":{"title":"The manualRefNum Schema","type":"string"},"parentRefNum":{"title":"The parentRefNum Schema","type":"string"},"maxAmount":{"title":"The Amount Schema","type":"number"},"presentmentAmount":{"title":"The Presentment Amount Schema","type":"number"},"presentmentCurrency":{"title":"The Presentment Currency Schema","type":"string"}}}},"tags":{"title":"The Return Tags Schema","type":"array"},"type":{"title":"The Type Schema","type":"string"},"createdDate":{"title":"The Createddate Schema","type":"string"},"returnDate":{"title":"The Returneddate Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"customerIdentificationType":{"title":"The CustomerIdentificationType Schema","type":"string"},"customerIdentificationValue":{"title":"The CustomerIdentificationValue Schema","type":"string"},"companyId":{"title":"The Companyid Schema","type":"string"},"companyExternalId":{"title":"The Companyexternalid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"returnIdentifications":{"title":"The Returnidentifications Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"returnIdentificationTypeId":{"title":"The Returnidentificationtypeid Schema","type":"string"},"returnIdentificationDesc":{"title":"The Returnidentificationdesc Schema","type":"string"},"idValue":{"title":"The Idvalue Schema","type":"string"}}}},"shipFrom":{"title":"The Shipfrom Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"itemExternalId":{"title":"The Itemexternalid Schema","type":"string"},"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"itemTypeId":{"title":"The Itemtypeid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"orderItemSeqId":{"title":"The Orderitemseqid Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"integer"},"reason":{"title":"The Reason Schema","type":"string"},"returnType":{"title":"The Returntype Schema","type":"string"},"restockType":{"title":"The Restocktype Schema","type":"string"},"price":{"title":"The Price Schema","type":"number"},"includeAdjustments":{"title":"The Includeadjustments Schema","type":"string"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}},"returnAdjustment":{"title":"The Returnadjustment Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}},"description":"In Schema for service: createReturn request"},"api.response.createReturn.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"payLoad":{"title":"The Root Schema","required":["type"],"type":"object","properties":{"externalId":{"title":"The Externalid Schema","type":"string"},"note":{"title":"The Return Note Schema","type":"string"},"returnPaymentPref":{"title":"The Return Payment Preference Schema","type":"array","items":{"title":"The Return Payment Pref item Schema","required":["paymentMethodTypeId","statusId"],"type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"paymentMethodTypeId":{"title":"The PaymentMethodTypeId Schema","type":"string"},"statusId":{"title":"The StatusId Schema","type":"string"},"manualRefNum":{"title":"The manualRefNum Schema","type":"string"},"parentRefNum":{"title":"The parentRefNum Schema","type":"string"},"maxAmount":{"title":"The Amount Schema","type":"number"},"presentmentAmount":{"title":"The Presentment Amount Schema","type":"number"},"presentmentCurrency":{"title":"The Presentment Currency Schema","type":"string"}}}},"tags":{"title":"The Return Tags Schema","type":"array"},"type":{"title":"The Type Schema","type":"string"},"createdDate":{"title":"The Createddate Schema","type":"string"},"returnDate":{"title":"The Returneddate Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"customerIdentificationType":{"title":"The CustomerIdentificationType Schema","type":"string"},"customerIdentificationValue":{"title":"The CustomerIdentificationValue Schema","type":"string"},"companyId":{"title":"The Companyid Schema","type":"string"},"companyExternalId":{"title":"The Companyexternalid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"returnIdentifications":{"title":"The Returnidentifications Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"returnIdentificationTypeId":{"title":"The Returnidentificationtypeid Schema","type":"string"},"returnIdentificationDesc":{"title":"The Returnidentificationdesc Schema","type":"string"},"idValue":{"title":"The Idvalue Schema","type":"string"}}}},"shipFrom":{"title":"The Shipfrom Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"itemExternalId":{"title":"The Itemexternalid Schema","type":"string"},"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"itemTypeId":{"title":"The Itemtypeid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"orderItemSeqId":{"title":"The Orderitemseqid Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"integer"},"reason":{"title":"The Reason Schema","type":"string"},"returnType":{"title":"The Returntype Schema","type":"string"},"restockType":{"title":"The Restocktype Schema","type":"string"},"price":{"title":"The Price Schema","type":"number"},"includeAdjustments":{"title":"The Includeadjustments Schema","type":"string"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}},"returnAdjustment":{"title":"The Returnadjustment Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}}}},"description":"Out Schema for service: createReturn response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createReturn":{"post":{"tags":["Exported Services"],"summary":"Create return/sales return based on API input parameters","description":"Create return/sales return based on API input parameters","operationId":"createReturn","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createReturn","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createReturn"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createReturn.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a new role type

> Create a new role type

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createRoleType":{"required":["description","roleTypeId"],"type":"object","properties":{"roleTypeId":{"type":"string"},"parentTypeId":{"type":"string"},"description":{"type":"string"}},"description":"In Schema for service: createRoleType request"},"api.response.createRoleType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createRoleType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createRoleType":{"post":{"tags":["Exported Services"],"summary":"Create a new role type","description":"Create a new role type","operationId":"createRoleType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createRoleType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createRoleType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createRoleType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Order Data based on API input parameters

> Create Order Data based on API input parameters

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createSalesOrder":{"required":["order"],"type":"object","properties":{"order":{"title":"The Root Schema","required":["statusId","productStoreId","shipGroup"],"type":"object","properties":{"externalId":{"title":"The Externalid Schema","type":"string"},"orderName":{"title":"The Order Name Schema","type":"string"},"locale":{"title":"The Order locale Schema","type":"string"},"tags":{"title":"The Order Tags Schema","type":"array"},"note":{"title":"The Order Note Schema","type":"array"},"channel":{"title":"The Channel Schema","type":"string"},"webSiteId":{"title":"The Website Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerIdentificationType":{"title":"The Customer Identification Type Schema","type":"string"},"customerIdentificationValue":{"title":"The Customer Identification Value Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"priority":{"title":"The Priority Schema","type":"string"},"orderDate":{"title":"The Orderdate Schema","type":"string"},"entryDate":{"title":"The Entrydate Schema","type":"string"},"expireDate":{"title":"The Expiredate Schema","type":"string"},"statusId":{"title":"The Statusid Schema","type":"string"},"productStoreId":{"title":"The Productstoreid Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"remainingSubTotal":{"title":"The Remainingsubtotal Schema","type":"number"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"autoApprove":{"title":"The Autoapprove Schema","type":"string"},"orderContacts":{"title":"The Order Contacts Schema","type":"object","properties":{"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The External Id Schema","type":"string"}}}}},"orderIdentifications":{"title":"The Orderidentifications Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"orderIdentificationTypeId":{"title":"The Orderidentificationtypeid Schema","type":"string"},"orderIdentificationDesc":{"title":"The Orderidentificationdesc Schema","type":"string"},"idValue":{"title":"The Idvalue Schema","type":"string"}}}},"orderAttributes":{"title":"The OrderAttributes Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"attrName":{"title":"The AttrName Schema","type":"string"},"attrValue":{"title":"The AttrValue Schema","type":"string"},"attrDescription":{"title":"The AttrDescription Schema","type":"string"}}}},"orderContents":{"title":"The orderContents Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"orderItemSeqId":{"title":"The orderItemSeqId Schema","type":"string"},"contentId":{"title":"The contentId Schema","type":"string"},"orderContentTypeId":{"title":"The orderContentTypeId Schema","type":"string"},"fromDate":{"title":"The fromDate Schema","type":"string"},"thruDate":{"title":"The thruDate Schema","type":"string"}}}},"shipGroup":{"title":"The Shipgroup Schema","type":"array","items":{"title":"The Items Schema","required":["items"],"type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"},"orderFacilityId":{"title":"The OrderFacilityId Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"},"maySplit":{"title":"The Maysplit Schema","type":"string"},"shipBy":{"title":"The Shipby Schema","type":"string"},"shipAfter":{"title":"The Shipafter Schema","type":"string"},"carrierPartyId":{"title":"The Carrierpartyid Schema","type":"string"},"shipmentMethodTypeId":{"title":"The shipmentMethodTypeid Schema","type":"string"},"trackingNumber":{"title":"The Trackingnumber Schema","type":"string"},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"},"additionalPurpose":{"title":"The additionalPurpose Schema","type":"string"}}},"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"phoneNumber":{"title":"The Phonenumber Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"productId":{"title":"The Productid Schema","type":"string"},"itemExternalId":{"title":"The Itemexternalid Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"number"},"unitListPrice":{"title":"The Unitlistprice Schema","type":"number"},"unitPrice":{"title":"The Unitprice Schema","type":"number"},"autoCancelDate":{"title":"The AutoCancelDate Schema","type":"string"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"exemptAmount":{"title":"The Exempt Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"},"setShipGroup":{"title":"The setShipGroup Schema","type":"string"}}}},"orderItemAttributes":{"title":"The orderItemAttributes Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"attrName":{"title":"The attribute name Schema","type":"string"},"attrValue":{"title":"The Comments Schema","type":"string"},"attrDescription":{"title":"The Amount Schema","type":"string"}}}},"orderItemAssociations":{"title":"The orderItemAssociations Schema","type":"array","items":{"title":"The Items Schema","required":["toOrderItemSeqId","toShipGroupSeqId","orderItemAssocTypeId"],"type":"object","properties":{"toOrderId":{"title":"The toOrderId Schema","type":"string"},"toOrderExternalId":{"title":"The toOrderExternalId Schema","type":"string"},"toOrderItemSeqId":{"title":"The toOrderItemSeqId Schema","type":"string"},"toShipGroupSeqId":{"title":"The toShipGroupSeqId Schema","type":"string"},"orderItemAssocTypeId":{"title":"The orderItemAssocTypeId Schema","type":"string"},"quantity":{"title":"The quantity Schema","type":"number"}}}}}}}}}},"orderAdjustments":{"title":"The Orderadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"exemptAmount":{"title":"The Exempt Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}},"orderPaymentPref":{"title":"The Orderpaymentpref Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"paymentMethodTypeId":{"title":"The Paymentmethodtypeid Schema","type":"string"},"paymentMode":{"title":"The Paymentmode Schema","type":"string"},"cardName":{"title":"The Cardname Schema","type":"string"},"code":{"title":"The Code Schema","type":"string"},"maxAmount":{"title":"The Maxamount Schema","type":"number"},"statusId":{"title":"The Statusid Schema","type":"string"}}}},"billTo":{"title":"The Billto Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"phoneNumber":{"title":"The Phonenumber Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}}}}},"description":"In Schema for service: createSalesOrder request"},"api.response.createSalesOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderId":{"type":"string"}}}},"description":"Out Schema for service: createSalesOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createSalesOrder":{"post":{"tags":["Exported Services"],"summary":"Create Order Data based on API input parameters","description":"Create Order Data based on API input parameters","operationId":"createSalesOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createSalesOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createSalesOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createSalesOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Search Preference

> Create Search Preference

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createSearchPreference":{"type":"object","properties":{"searchPrefName":{"type":"string"},"isPublic":{"type":"string"},"searchPrefValue":{"type":"string"}},"description":"In Schema for service: createSearchPreference request"},"api.response.createSearchPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"searchPrefId":{"type":"string"}}}},"description":"Out Schema for service: createSearchPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createSearchPreference":{"post":{"tags":["Exported Services"],"summary":"Create Search Preference","description":"Create Search Preference","operationId":"createSearchPreference","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createSearchPreference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createSearchPreference"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createSearchPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create an SecurityGroup

> Create an SecurityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createSecurityGroup":{"required":["groupId"],"type":"object","properties":{"groupName":{"type":"string"},"groupId":{"type":"string"},"description":{"type":"string"},"groupTypeEnumId":{"type":"string"}},"description":"In Schema for service: createSecurityGroup request"},"api.response.createSecurityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createSecurityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createSecurityGroup":{"post":{"tags":["Exported Services"],"summary":"Create an SecurityGroup","description":"Create an SecurityGroup","operationId":"createSecurityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createSecurityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createSecurityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createSecurityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a SecurityPermission

> Create a SecurityPermission

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createSecurityPermission":{"required":["permissionId"],"type":"object","properties":{"permissionId":{"type":"string"},"description":{"type":"string"}},"description":"In Schema for service: createSecurityPermission request"},"api.response.createSecurityPermission.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createSecurityPermission response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createSecurityPermission":{"post":{"tags":["Exported Services"],"summary":"Create a SecurityPermission","description":"Create a SecurityPermission","operationId":"createSecurityPermission","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createSecurityPermission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createSecurityPermission"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createSecurityPermission.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a ShipmentBoxType record

> Create a ShipmentBoxType record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShipmentBoxType":{"type":"object","properties":{"boxLength":{"type":"number"},"boxWeight":{"type":"number"},"dimensionUomId":{"type":"string"},"weightUomId":{"type":"string"},"description":{"type":"string"},"boxHeight":{"type":"number"},"boxWidth":{"type":"number"},"shipmentBoxTypeId":{"type":"string"}},"description":"In Schema for service: createShipmentBoxType request"},"api.response.createShipmentBoxType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipmentBoxTypeId":{"type":"string"}}}},"description":"Out Schema for service: createShipmentBoxType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShipmentBoxType":{"post":{"tags":["Exported Services"],"summary":"Create a ShipmentBoxType record","description":"Create a ShipmentBoxType record","operationId":"createShipmentBoxType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShipmentBoxType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShipmentBoxType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShipmentBoxType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create ShipmentItem

> Create ShipmentItem

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShipmentItem":{"required":["shipmentId"],"type":"object","properties":{"availableToPromise":{"type":"number"},"serialNumber":{"type":"string"},"quantity":{"type":"number"},"productId":{"type":"string"},"shipmentContentDescription":{"type":"string"},"shipmentId":{"type":"string"},"externalId":{"type":"string"},"shipmentItemSeqId":{"type":"string"}},"description":"In Schema for service: createShipmentItem request"},"api.response.createShipmentItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipmentItemSeqId":{"type":"string"}}}},"description":"Out Schema for service: createShipmentItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShipmentItem":{"post":{"tags":["Exported Services"],"summary":"Create ShipmentItem","description":"Create ShipmentItem","operationId":"createShipmentItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShipmentItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShipmentItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShipmentItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates A ShipmentMethodType

> Creates A ShipmentMethodType

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShipmentMethodType":{"required":["shipmentMethodTypeId"],"type":"object","properties":{"parentTypeId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"description":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: createShipmentMethodType request"},"api.response.createShipmentMethodType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createShipmentMethodType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShipmentMethodType":{"post":{"tags":["Exported Services"],"summary":"Creates A ShipmentMethodType","description":"Creates A ShipmentMethodType","operationId":"createShipmentMethodType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShipmentMethodType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShipmentMethodType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShipmentMethodType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates a ShipmentReceipt Record

> Creates a ShipmentReceipt Record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShipmentReceipt":{"required":["inventoryItemId","productId","quantityAccepted","quantityRejected"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"productId":{"type":"string"},"orderId":{"type":"string"},"quantityAccepted":{"type":"number"},"shipmentPackageSeqId":{"type":"string"},"quantityRejected":{"type":"number"},"shipmentItemSeqId":{"type":"string"},"inventoryItemDetailSeqId":{"type":"string"},"affectAccounting":{"type":"boolean"},"rejectionId":{"type":"string"},"inventoryItemId":{"type":"string"},"receivedByUserLoginId":{"type":"string"},"shipmentId":{"type":"string"},"returnId":{"type":"string"},"returnItemSeqId":{"type":"string"},"datetimeReceived":{"type":"string","format":"date"},"itemDescription":{"type":"string"}},"description":"In Schema for service: createShipmentReceipt request"},"api.response.createShipmentReceipt.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"receiptId":{"type":"string"},"affectAccounting":{"type":"boolean"}}}},"description":"Out Schema for service: createShipmentReceipt response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShipmentReceipt":{"post":{"tags":["Exported Services"],"summary":"Creates a ShipmentReceipt Record","description":"Creates a ShipmentReceipt Record","operationId":"createShipmentReceipt","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShipmentReceipt","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShipmentReceipt"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShipmentReceipt.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Import Shopify Orders

> Import Shopify Orders

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShopifyOrder":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"payload":{"type":"object"}},"description":"In Schema for service: createShopifyOrder request"},"api.response.createShopifyOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"isFulfilled":{"type":"string"},"orderId":{"type":"string"},"autoApproveOrder":{"type":"string"}}}},"description":"Out Schema for service: createShopifyOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShopifyOrder":{"post":{"tags":["Exported Services"],"summary":"Import Shopify Orders","description":"Import Shopify Orders","operationId":"createShopifyOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShopifyOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShopifyOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShopifyOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates a ShopifyProdLocActivation record

> Creates a ShopifyProdLocActivation record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShopifyProdLocActivation":{"type":"object","properties":{"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"},"shopifyProductId":{"type":"string"},"activated":{"type":"string"}},"description":"In Schema for service: createShopifyProdLocActivation request"},"api.response.createShopifyProdLocActivation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"},"shopifyProductId":{"type":"string"}}}},"description":"Out Schema for service: createShopifyProdLocActivation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShopifyProdLocActivation":{"post":{"tags":["Exported Services"],"summary":"Creates a ShopifyProdLocActivation record","description":"Creates a ShopifyProdLocActivation record","operationId":"createShopifyProdLocActivation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShopifyProdLocActivation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShopifyProdLocActivation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShopifyProdLocActivation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create return/sales return based on API input parameters

> Create return/sales return based on API input parameters

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShopifyReturn":{"required":["payLoad"],"type":"object","properties":{"payLoad":{"title":"The Root Schema","required":["type"],"type":"object","properties":{"externalId":{"title":"The Externalid Schema","type":"string"},"note":{"title":"The Return Note Schema","type":"string"},"returnPaymentPref":{"title":"The Return Payment Preference Schema","type":"array","items":{"title":"The Return Payment Pref item Schema","required":["paymentMethodTypeId","statusId"],"type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"paymentMethodTypeId":{"title":"The PaymentMethodTypeId Schema","type":"string"},"statusId":{"title":"The StatusId Schema","type":"string"},"manualRefNum":{"title":"The manualRefNum Schema","type":"string"},"parentRefNum":{"title":"The parentRefNum Schema","type":"string"},"maxAmount":{"title":"The Amount Schema","type":"number"},"presentmentAmount":{"title":"The Presentment Amount Schema","type":"number"},"presentmentCurrency":{"title":"The Presentment Currency Schema","type":"string"}}}},"tags":{"title":"The Return Tags Schema","type":"array"},"type":{"title":"The Type Schema","type":"string"},"createdDate":{"title":"The Createddate Schema","type":"string"},"returnDate":{"title":"The Returneddate Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"customerIdentificationType":{"title":"The CustomerIdentificationType Schema","type":"string"},"customerIdentificationValue":{"title":"The CustomerIdentificationValue Schema","type":"string"},"companyId":{"title":"The Companyid Schema","type":"string"},"companyExternalId":{"title":"The Companyexternalid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"returnIdentifications":{"title":"The Returnidentifications Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"returnIdentificationTypeId":{"title":"The Returnidentificationtypeid Schema","type":"string"},"returnIdentificationDesc":{"title":"The Returnidentificationdesc Schema","type":"string"},"idValue":{"title":"The Idvalue Schema","type":"string"}}}},"shipFrom":{"title":"The Shipfrom Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"itemExternalId":{"title":"The Itemexternalid Schema","type":"string"},"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"itemTypeId":{"title":"The Itemtypeid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"orderItemSeqId":{"title":"The Orderitemseqid Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"integer"},"reason":{"title":"The Reason Schema","type":"string"},"returnType":{"title":"The Returntype Schema","type":"string"},"restockType":{"title":"The Restocktype Schema","type":"string"},"price":{"title":"The Price Schema","type":"number"},"includeAdjustments":{"title":"The Includeadjustments Schema","type":"string"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}},"returnAdjustment":{"title":"The Returnadjustment Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}},"description":"In Schema for service: createShopifyReturn request"},"api.response.createShopifyReturn.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"payLoad":{"title":"The Root Schema","required":["type"],"type":"object","properties":{"externalId":{"title":"The Externalid Schema","type":"string"},"note":{"title":"The Return Note Schema","type":"string"},"returnPaymentPref":{"title":"The Return Payment Preference Schema","type":"array","items":{"title":"The Return Payment Pref item Schema","required":["paymentMethodTypeId","statusId"],"type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"paymentMethodTypeId":{"title":"The PaymentMethodTypeId Schema","type":"string"},"statusId":{"title":"The StatusId Schema","type":"string"},"manualRefNum":{"title":"The manualRefNum Schema","type":"string"},"parentRefNum":{"title":"The parentRefNum Schema","type":"string"},"maxAmount":{"title":"The Amount Schema","type":"number"},"presentmentAmount":{"title":"The Presentment Amount Schema","type":"number"},"presentmentCurrency":{"title":"The Presentment Currency Schema","type":"string"}}}},"tags":{"title":"The Return Tags Schema","type":"array"},"type":{"title":"The Type Schema","type":"string"},"createdDate":{"title":"The Createddate Schema","type":"string"},"returnDate":{"title":"The Returneddate Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"customerIdentificationType":{"title":"The CustomerIdentificationType Schema","type":"string"},"customerIdentificationValue":{"title":"The CustomerIdentificationValue Schema","type":"string"},"companyId":{"title":"The Companyid Schema","type":"string"},"companyExternalId":{"title":"The Companyexternalid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"returnIdentifications":{"title":"The Returnidentifications Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"returnIdentificationTypeId":{"title":"The Returnidentificationtypeid Schema","type":"string"},"returnIdentificationDesc":{"title":"The Returnidentificationdesc Schema","type":"string"},"idValue":{"title":"The Idvalue Schema","type":"string"}}}},"shipFrom":{"title":"The Shipfrom Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"itemExternalId":{"title":"The Itemexternalid Schema","type":"string"},"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"itemTypeId":{"title":"The Itemtypeid Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"orderItemSeqId":{"title":"The Orderitemseqid Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"integer"},"reason":{"title":"The Reason Schema","type":"string"},"returnType":{"title":"The Returntype Schema","type":"string"},"restockType":{"title":"The Restocktype Schema","type":"string"},"price":{"title":"The Price Schema","type":"number"},"includeAdjustments":{"title":"The Includeadjustments Schema","type":"string"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}},"returnAdjustment":{"title":"The Returnadjustment Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"orderId":{"title":"The Orderid Schema","type":"string"},"orderExternalId":{"title":"The Orderexternalid Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"description":{"title":"The Description Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}}}},"description":"Out Schema for service: createShopifyReturn response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShopifyReturn":{"post":{"tags":["Exported Services"],"summary":"Create return/sales return based on API input parameters","description":"Create return/sales return based on API input parameters","operationId":"createShopifyReturn","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShopifyReturn","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShopifyReturn"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShopifyReturn.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a ShopifyShopCarrierShipment record

> Create a ShopifyShopCarrierShipment record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShopifyShopCarrierShipment":{"type":"object","properties":{"carrierPartyId":{"type":"string"},"shopifyShippingMethod":{"type":"string"},"shopId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: createShopifyShopCarrierShipment request"},"api.response.createShopifyShopCarrierShipment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shopifyShippingMethod":{"type":"string"},"shopId":{"type":"string"}}}},"description":"Out Schema for service: createShopifyShopCarrierShipment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShopifyShopCarrierShipment":{"post":{"tags":["Exported Services"],"summary":"Create a ShopifyShopCarrierShipment record","description":"Create a ShopifyShopCarrierShipment record","operationId":"createShopifyShopCarrierShipment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShopifyShopCarrierShipment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShopifyShopCarrierShipment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShopifyShopCarrierShipment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create a ShopifyShopLocation record

> Create a ShopifyShopLocation record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createShopifyShopLocation":{"type":"object","properties":{"facilityId":{"type":"string"},"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"}},"description":"In Schema for service: createShopifyShopLocation request"},"api.response.createShopifyShopLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"facilityId":{"type":"string"},"shopId":{"type":"string"}}}},"description":"Out Schema for service: createShopifyShopLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createShopifyShopLocation":{"post":{"tags":["Exported Services"],"summary":"Create a ShopifyShopLocation record","description":"Create a ShopifyShopLocation record","operationId":"createShopifyShopLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createShopifyShopLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createShopifyShopLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createShopifyShopLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create system property

> Create system property

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createSystemProperty":{"required":["systemPropertyId","systemResourceId"],"type":"object","properties":{"systemPropertyValue":{"type":"string"},"systemResourceId":{"type":"string"},"description":{"type":"string"},"systemPropertyId":{"type":"string"}},"description":"In Schema for service: createSystemProperty request"},"api.response.createSystemProperty.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"systemResourceId":{"type":"string"},"systemPropertyId":{"type":"string"}}}},"description":"Out Schema for service: createSystemProperty response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createSystemProperty":{"post":{"tags":["Exported Services"],"summary":"Create system property","description":"Create system property","operationId":"createSystemProperty","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createSystemProperty","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createSystemProperty"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createSystemProperty.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create/Update Order Adjustment

> Create/Update Order Adjustment

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUpdateOrderAdjustment":{"type":"object","properties":{"customerReferenceId":{"type":"string"},"correspondingProductId":{"type":"string"},"orderId":{"type":"string"},"includeInShipping":{"type":"string"},"description":{"type":"string"},"exemptAmount":{"type":"number"},"productPromoId":{"type":"string"},"taxAuthPartyId":{"type":"string"},"lastModifiedByUserLogin":{"type":"string"},"oldPercentage":{"type":"number"},"primaryGeoId":{"type":"string"},"taxAuthGeoId":{"type":"string"},"originalAdjustmentId":{"type":"string"},"secondaryGeoId":{"type":"string"},"createdByUserLogin":{"type":"string"},"amountAlreadyIncluded":{"type":"number"},"orderAdjustmentId":{"type":"string"},"orderItemSeqId":{"type":"string"},"amount":{"type":"number"},"comments":{"type":"string"},"recurringAmount":{"type":"number"},"lastModifiedDate":{"type":"string","format":"date"},"sourceReferenceId":{"type":"string"},"isManual":{"type":"string"},"productPromoRuleId":{"type":"string"},"orderAdjustmentTypeId":{"type":"string"},"taxAuthorityRateSeqId":{"type":"string"},"productFeatureId":{"type":"string"},"oldAmountPerQuantity":{"type":"number"},"overrideGlAccountId":{"type":"string"},"shipGroupSeqId":{"type":"string"},"includeInTax":{"type":"string"},"createdDate":{"type":"string","format":"date"},"productPromoActionSeqId":{"type":"string"},"billingShipmentId":{"type":"string"},"sourcePercentage":{"type":"number"}},"description":"In Schema for service: createUpdateOrderAdjustment request"},"api.response.createUpdateOrderAdjustment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createUpdateOrderAdjustment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUpdateOrderAdjustment":{"post":{"tags":["Exported Services"],"summary":"Create/Update Order Adjustment","description":"Create/Update Order Adjustment","operationId":"createUpdateOrderAdjustment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUpdateOrderAdjustment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUpdateOrderAdjustment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUpdateOrderAdjustment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create or update a OrderAttribute

> Create or update a OrderAttribute

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUpdateOrderAttribute":{"required":["attrName","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"attrDescription":{"type":"string"},"attrValue":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: createUpdateOrderAttribute request"},"api.response.createUpdateOrderAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createUpdateOrderAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUpdateOrderAttribute":{"post":{"tags":["Exported Services"],"summary":"Create or update a OrderAttribute","description":"Create or update a OrderAttribute","operationId":"createUpdateOrderAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUpdateOrderAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUpdateOrderAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUpdateOrderAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create and Update email address

> Create and Update email address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUpdatePartyEmailAddress":{"required":["contactMechId","emailAddress"],"type":"object","properties":{"emailAddress":{"type":"string"},"contactMechPurposeTypeId":{"type":"string"},"partyId":{"type":"string"},"contactMechId":{"type":"string"}},"description":"In Schema for service: createUpdatePartyEmailAddress request"},"api.response.createUpdatePartyEmailAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"emailAddress":{"type":"string"},"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createUpdatePartyEmailAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUpdatePartyEmailAddress":{"post":{"tags":["Exported Services"],"summary":"Create and Update email address","description":"Create and Update email address","operationId":"createUpdatePartyEmailAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUpdatePartyEmailAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUpdatePartyEmailAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUpdatePartyEmailAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create and Update telecom number

> Create and Update telecom number

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUpdatePartyTelecomNumber":{"required":["partyId"],"type":"object","properties":{"askForName":{"type":"string"},"extension":{"type":"string"},"roleTypeId":{"type":"string"},"comments":{"type":"string"},"verified":{"type":"string"},"monthsWithContactMech":{"type":"integer","format":"int32"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"},"fromDate":{"type":"string","format":"date"},"areaCode":{"type":"string"},"allowSolicitation":{"type":"string"},"yearsWithContactMech":{"type":"integer","format":"int32"},"contactMechPurposeTypeId":{"type":"string"},"countryCode":{"type":"string"},"contactNumber":{"type":"string"},"partyId":{"type":"string"}},"description":"In Schema for service: createUpdatePartyTelecomNumber request"},"api.response.createUpdatePartyTelecomNumber.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createUpdatePartyTelecomNumber response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUpdatePartyTelecomNumber":{"post":{"tags":["Exported Services"],"summary":"Create and Update telecom number","description":"Create and Update telecom number","operationId":"createUpdatePartyTelecomNumber","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUpdatePartyTelecomNumber","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUpdatePartyTelecomNumber"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUpdatePartyTelecomNumber.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates new shipping address and update existing address

> Creates new shipping address and update existing address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUpdateShippingAddress":{"required":["shipToAddress1","shipToCity","shipToCountryGeoId","shipToPostalCode","shipToStateProvinceGeoId"],"type":"object","properties":{"setDefaultShipping":{"type":"string"},"shipToContactMechId":{"type":"string"},"shipToStateProvinceGeoId":{"type":"string"},"shipToCity":{"type":"string"},"keepAddressBook":{"type":"string"},"shipToPostalCode":{"type":"string"},"shipToAddress1":{"type":"string"},"billToContactMechId":{"type":"string"},"shipToAddress2":{"type":"string"},"shipToCountryGeoId":{"type":"string"},"shipToName":{"type":"string"},"productStoreId":{"type":"string"},"partyId":{"type":"string"},"shipToAttnName":{"type":"string"}},"description":"In Schema for service: createUpdateShippingAddress request"},"api.response.createUpdateShippingAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: createUpdateShippingAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUpdateShippingAddress":{"post":{"tags":["Exported Services"],"summary":"Creates new shipping address and update existing address","description":"Creates new shipping address and update existing address","operationId":"createUpdateShippingAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUpdateShippingAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUpdateShippingAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUpdateShippingAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Shop name eg. myshop is shop name for <https://myshop.myshopify.com&#x20>;

> Shop name eg. myshop is shop name for <https://myshop.myshopify.com&#x20>;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUpdateShopifyShop":{"required":["accessToken","clientId","shop","shopId","shopifyConfigName"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"clientId":{"type":"string"},"shop":{"type":"string"},"processRefund":{"type":"string"},"shopifyConfigName":{"type":"string"},"shopId":{"type":"string"},"productStoreId":{"type":"string"},"oldSharedSecret":{"type":"string"},"accessToken":{"type":"string"},"sharedSecret":{"type":"string"},"webSiteId":{"type":"string"}},"description":"In Schema for service: createUpdateShopifyShop request"},"api.response.createUpdateShopifyShop.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shopId":{"type":"string"}}}},"description":"Out Schema for service: createUpdateShopifyShop response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUpdateShopifyShop":{"post":{"tags":["Exported Services"],"summary":"Shop name eg. myshop is shop name for https://myshop.myshopify.com ","description":"Shop name eg. myshop is shop name for https://myshop.myshopify.com ","operationId":"createUpdateShopifyShop","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUpdateShopifyShop","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUpdateShopifyShop"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUpdateShopifyShop.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create User Search Preference

> Create User Search Preference

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.createUserSearchPreference":{"required":["searchPrefId","userSearchPrefTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"userSearchPrefTypeId":{"type":"string"},"searchPrefId":{"type":"string"}},"description":"In Schema for service: createUserSearchPreference request"},"api.response.createUserSearchPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: createUserSearchPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/createUserSearchPreference":{"post":{"tags":["Exported Services"],"summary":"Create User Search Preference","description":"Create User Search Preference","operationId":"createUserSearchPreference","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service createUserSearchPreference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.createUserSearchPreference"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.createUserSearchPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a CarrierGeoMapping record

> Delete a CarrierGeoMapping record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteCarrierGeoMapping":{"required":["geoMapId"],"type":"object","properties":{"geoName":{"type":"string"},"geoTypeId":{"type":"string"},"carrierPartyId":{"type":"string"},"geoMapId":{"type":"string"},"geoId":{"type":"string"},"carrierGeoValue":{"type":"string"}},"description":"In Schema for service: deleteCarrierGeoMapping request"},"api.response.deleteCarrierGeoMapping.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteCarrierGeoMapping response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteCarrierGeoMapping":{"post":{"tags":["Exported Services"],"summary":"Delete a CarrierGeoMapping record","description":"Delete a CarrierGeoMapping record","operationId":"deleteCarrierGeoMapping","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteCarrierGeoMapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteCarrierGeoMapping"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteCarrierGeoMapping.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete an existing Carrier Shipment Box Type Record

> Delete an existing Carrier Shipment Box Type Record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteCarrierShipmentBoxType":{"required":["partyId","shipmentBoxTypeId"],"type":"object","properties":{"partyId":{"type":"string"},"shipmentBoxTypeId":{"type":"string"}},"description":"In Schema for service: deleteCarrierShipmentBoxType request"},"api.response.deleteCarrierShipmentBoxType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteCarrierShipmentBoxType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteCarrierShipmentBoxType":{"post":{"tags":["Exported Services"],"summary":"Delete an existing Carrier Shipment Box Type Record","description":"Delete an existing Carrier Shipment Box Type Record","operationId":"deleteCarrierShipmentBoxType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteCarrierShipmentBoxType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteCarrierShipmentBoxType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteCarrierShipmentBoxType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Deletes A CarrierShipmentMethod

> Deletes A CarrierShipmentMethod

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteCarrierShipmentMethod":{"required":["partyId","roleTypeId","shipmentMethodTypeId"],"type":"object","properties":{"roleTypeId":{"type":"string"},"partyId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: deleteCarrierShipmentMethod request"},"api.response.deleteCarrierShipmentMethod.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteCarrierShipmentMethod response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteCarrierShipmentMethod":{"post":{"tags":["Exported Services"],"summary":"Deletes A CarrierShipmentMethod","description":"Deletes A CarrierShipmentMethod","operationId":"deleteCarrierShipmentMethod","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteCarrierShipmentMethod","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteCarrierShipmentMethod"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteCarrierShipmentMethod.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a DataManagerMapping

> Delete a DataManagerMapping

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteDataManagerMapping":{"required":["mappingPrefId"],"type":"object","properties":{"mappingPrefId":{"type":"string"}},"description":"In Schema for service: deleteDataManagerMapping request"},"api.response.deleteDataManagerMapping.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteDataManagerMapping response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteDataManagerMapping":{"post":{"tags":["Exported Services"],"summary":"Delete a DataManagerMapping","description":"Delete a DataManagerMapping","operationId":"deleteDataManagerMapping","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteDataManagerMapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteDataManagerMapping"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteDataManagerMapping.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a Enumeration

> Delete a Enumeration

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteEnumeration":{"required":["enumId"],"type":"object","properties":{"enumId":{"type":"string"}},"description":"In Schema for service: deleteEnumeration request"},"api.response.deleteEnumeration.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteEnumeration response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteEnumeration":{"post":{"tags":["Exported Services"],"summary":"Delete a Enumeration","description":"Delete a Enumeration","operationId":"deleteEnumeration","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteEnumeration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteEnumeration"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteEnumeration.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete enumeration group member

> Delete enumeration group member

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteEnumerationGroupMember":{"required":["enumerationGroupId","enumerationId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"enumerationId":{"type":"string"},"enumerationGroupId":{"type":"string"}},"description":"In Schema for service: deleteEnumerationGroupMember request"},"api.response.deleteEnumerationGroupMember.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteEnumerationGroupMember response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteEnumerationGroupMember":{"post":{"tags":["Exported Services"],"summary":"Delete enumeration group member","description":"Delete enumeration group member","operationId":"deleteEnumerationGroupMember","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteEnumerationGroupMember","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteEnumerationGroupMember"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteEnumerationGroupMember.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a ExternalFulfillmentOrderItem record

> Delete a ExternalFulfillmentOrderItem record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteExternalFulfillmentOrderItem":{"required":["externalFulfillmentOrderItemId"],"type":"object","properties":{"externalFulfillmentOrderItemId":{"type":"string"}},"description":"In Schema for service: deleteExternalFulfillmentOrderItem request"},"api.response.deleteExternalFulfillmentOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteExternalFulfillmentOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteExternalFulfillmentOrderItem":{"post":{"tags":["Exported Services"],"summary":"Delete a ExternalFulfillmentOrderItem record","description":"Delete a ExternalFulfillmentOrderItem record","operationId":"deleteExternalFulfillmentOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteExternalFulfillmentOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteExternalFulfillmentOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteExternalFulfillmentOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a Facility Group

> Delete a Facility Group

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteFacilityGroup":{"required":["facilityGroupId"],"type":"object","properties":{"facilityGroupId":{"type":"string"}},"description":"In Schema for service: deleteFacilityGroup request"},"api.response.deleteFacilityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteFacilityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteFacilityGroup":{"post":{"tags":["Exported Services"],"summary":"Delete a Facility Group","description":"Delete a Facility Group","operationId":"deleteFacilityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteFacilityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteFacilityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteFacilityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a Facility Location

> Delete a Facility Location

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteFacilityLocation":{"required":["facilityId","locationSeqId"],"type":"object","properties":{"facilityId":{"type":"string"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: deleteFacilityLocation request"},"api.response.deleteFacilityLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteFacilityLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteFacilityLocation":{"post":{"tags":["Exported Services"],"summary":"Delete a Facility Location","description":"Delete a Facility Location","operationId":"deleteFacilityLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteFacilityLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteFacilityLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteFacilityLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete an OrderAttribute record

> Delete an OrderAttribute record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteOrderAttribute":{"required":["attrName","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: deleteOrderAttribute request"},"api.response.deleteOrderAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteOrderAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteOrderAttribute":{"post":{"tags":["Exported Services"],"summary":"Delete an OrderAttribute record","description":"Delete an OrderAttribute record","operationId":"deleteOrderAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteOrderAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteOrderAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteOrderAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete Order Item Attribute

> Delete Order Item Attribute

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteOrderItemAttribute":{"required":["attrName","orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: deleteOrderItemAttribute request"},"api.response.deleteOrderItemAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteOrderItemAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteOrderItemAttribute":{"post":{"tags":["Exported Services"],"summary":"Delete Order Item Attribute","description":"Delete Order Item Attribute","operationId":"deleteOrderItemAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteOrderItemAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteOrderItemAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteOrderItemAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a PartyContactMech

> Delete a PartyContactMech

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deletePartyContactMech":{"required":["contactMechId"],"type":"object","properties":{"partyId":{"type":"string"},"contactMechId":{"type":"string"}},"description":"In Schema for service: deletePartyContactMech request"},"api.response.deletePartyContactMech.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deletePartyContactMech response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deletePartyContactMech":{"post":{"tags":["Exported Services"],"summary":"Delete a PartyContactMech","description":"Delete a PartyContactMech","operationId":"deletePartyContactMech","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deletePartyContactMech","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deletePartyContactMech"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deletePartyContactMech.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR\_DELETE or have\
&#x20;           permission to change the role of this partyId
--------------------------------------------------------------

> Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR\_DELETE or have\
> &#x20;           permission to change the role of this partyId

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deletePartyRole":{"required":["partyId","roleTypeId"],"type":"object","properties":{"roleTypeId":{"type":"string"},"partyId":{"type":"string"}},"description":"In Schema for service: deletePartyRole request"},"api.response.deletePartyRole.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deletePartyRole response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deletePartyRole":{"post":{"tags":["Exported Services"],"summary":"Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR_DELETE or have\n            permission to change the role of this partyId","description":"Delete a Party Role (remove a Role from a Party). The logged in user must have PARTYMGR_DELETE or have\n            permission to change the role of this partyId","operationId":"deletePartyRole","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deletePartyRole","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deletePartyRole"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deletePartyRole.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a ProductStoreFacilityGroup

> Delete a ProductStoreFacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteProductStoreFacilityGroup":{"required":["facilityGroupId","fromDate","productStoreId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityGroupId":{"type":"string"},"productStoreId":{"type":"string"}},"description":"In Schema for service: deleteProductStoreFacilityGroup request"},"api.response.deleteProductStoreFacilityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteProductStoreFacilityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteProductStoreFacilityGroup":{"post":{"tags":["Exported Services"],"summary":"Delete a ProductStoreFacilityGroup","description":"Delete a ProductStoreFacilityGroup","operationId":"deleteProductStoreFacilityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteProductStoreFacilityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteProductStoreFacilityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteProductStoreFacilityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete ShipmentItem

> Delete ShipmentItem

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteShipmentItem":{"required":["shipmentId","shipmentItemSeqId"],"type":"object","properties":{"shipmentId":{"type":"string"},"shipmentItemSeqId":{"type":"string"}},"description":"In Schema for service: deleteShipmentItem request"},"api.response.deleteShipmentItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteShipmentItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteShipmentItem":{"post":{"tags":["Exported Services"],"summary":"Delete ShipmentItem","description":"Delete ShipmentItem","operationId":"deleteShipmentItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteShipmentItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteShipmentItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteShipmentItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Deletes A ShipmentMethodType

> Deletes A ShipmentMethodType

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteShipmentMethodType":{"required":["shipmentMethodTypeId"],"type":"object","properties":{"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: deleteShipmentMethodType request"},"api.response.deleteShipmentMethodType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteShipmentMethodType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteShipmentMethodType":{"post":{"tags":["Exported Services"],"summary":"Deletes A ShipmentMethodType","description":"Deletes A ShipmentMethodType","operationId":"deleteShipmentMethodType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteShipmentMethodType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteShipmentMethodType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteShipmentMethodType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a ShopifyShopCarrierShipment record

> Delete a ShopifyShopCarrierShipment record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteShopifyShopCarrierShipment":{"required":["shopId","shopifyShippingMethod"],"type":"object","properties":{"carrierPartyId":{"type":"string"},"shopifyShippingMethod":{"type":"string"},"shopId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: deleteShopifyShopCarrierShipment request"},"api.response.deleteShopifyShopCarrierShipment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteShopifyShopCarrierShipment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteShopifyShopCarrierShipment":{"post":{"tags":["Exported Services"],"summary":"Delete a ShopifyShopCarrierShipment record","description":"Delete a ShopifyShopCarrierShipment record","operationId":"deleteShopifyShopCarrierShipment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteShopifyShopCarrierShipment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteShopifyShopCarrierShipment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteShopifyShopCarrierShipment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Delete a ShopifyShopLocation record

> Delete a ShopifyShopLocation record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.deleteShopifyShopLocation":{"required":["facilityId","shopId"],"type":"object","properties":{"facilityId":{"type":"string"},"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"}},"description":"In Schema for service: deleteShopifyShopLocation request"},"api.response.deleteShopifyShopLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: deleteShopifyShopLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/deleteShopifyShopLocation":{"post":{"tags":["Exported Services"],"summary":"Delete a ShopifyShopLocation record","description":"Delete a ShopifyShopLocation record","operationId":"deleteShopifyShopLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service deleteShopifyShopLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.deleteShopifyShopLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.deleteShopifyShopLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/doRateShopping

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.doRateShopping":{"required":["shipmentId"],"type":"object","properties":{"shipmentId":{"type":"string"},"forceRateShop":{"type":"boolean"},"generateLabel":{"type":"boolean"}},"description":"In Schema for service: doRateShopping request"},"api.response.doRateShopping.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"carrierPartyId":{"type":"string"},"shipmentRouteSegmentId":{"type":"string"},"billingWeight":{"type":"number"},"billingWeightUomId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"actualCost":{"type":"number"}}}},"description":"Out Schema for service: doRateShopping response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/doRateShopping":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"doRateShopping","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service doRateShopping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.doRateShopping"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.doRateShopping.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Ensure that the party is in the specified role.

> Ensure that the party is in the specified role.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.ensurePartyRole":{"required":["partyId","roleTypeId"],"type":"object","properties":{"roleTypeId":{"type":"string"},"partyId":{"type":"string"}},"description":"In Schema for service: ensurePartyRole request"},"api.response.ensurePartyRole.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: ensurePartyRole response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/ensurePartyRole":{"post":{"tags":["Exported Services"],"summary":"Ensure that the party is in the specified role.","description":"Ensure that the party is in the specified role.","operationId":"ensurePartyRole","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service ensurePartyRole","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.ensurePartyRole"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.ensurePartyRole.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Send a post request to run a DAG in airflow

> Send a post request to run a DAG in airflow

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.executeServiceFromAirflow":{"required":["dagId","serviceName"],"type":"object","properties":{"payload":{"type":"object"},"dagId":{"type":"string"},"airflowPayload":{"type":"object"},"serviceName":{"type":"string"}},"description":"In Schema for service: executeServiceFromAirflow request"},"api.response.executeServiceFromAirflow.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: executeServiceFromAirflow response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/executeServiceFromAirflow":{"post":{"tags":["Exported Services"],"summary":"Send a post request to run a DAG in airflow","description":"Send a post request to run a DAG in airflow","operationId":"executeServiceFromAirflow","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service executeServiceFromAirflow","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.executeServiceFromAirflow"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.executeServiceFromAirflow.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Expire a FacilityCalendar Record

> Expire a FacilityCalendar Record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.expireFacilityCalendar":{"required":["calendarId","facilityCalendarTypeId","facilityId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"calendarId":{"type":"string"},"facilityCalendarTypeId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: expireFacilityCalendar request"},"api.response.expireFacilityCalendar.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: expireFacilityCalendar response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/expireFacilityCalendar":{"post":{"tags":["Exported Services"],"summary":"Expire a FacilityCalendar Record","description":"Expire a FacilityCalendar Record","operationId":"expireFacilityCalendar","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service expireFacilityCalendar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.expireFacilityCalendar"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.expireFacilityCalendar.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.findProductById":{"required":["idToFind"],"type":"object","properties":{"idToFind":{"type":"string"},"searchAllId":{"type":"string"},"goodIdentificationTypeId":{"type":"string"},"searchProductFirst":{"type":"string"}},"description":"In Schema for service: findProductById request"},"api.response.findProductById.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"productsList":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: findProductById response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/findProductById":{"get":{"tags":["Exported Services"],"summary":"Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue","description":"Finds productId(s) corresponding to a product reference, productId or a GoodIdentification idValue","operationId":"findProductById","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.findProductById"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.findProductById.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Set hasLoggedOut to Y.

> Set hasLoggedOut to Y.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.forceLogout":{"required":["userLoginId"],"type":"object","properties":{"userLoginId":{"type":"string"}},"description":"In Schema for service: forceLogout request"},"api.response.forceLogout.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: forceLogout response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/forceLogout":{"post":{"tags":["Exported Services"],"summary":"Set hasLoggedOut to Y.","description":"Set hasLoggedOut to Y.","operationId":"forceLogout","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service forceLogout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.forceLogout"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forceLogout.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Address Validation Request

> Address Validation Request

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.gatewayShipAddressValidationRequest":{"type":"object","properties":{"carrierPartyId":{"type":"string"},"shipmentGatewayConfigId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"contactMechId":{"type":"string"}},"description":"In Schema for service: gatewayShipAddressValidationRequest request"},"api.response.gatewayShipAddressValidationRequest.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: gatewayShipAddressValidationRequest response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/gatewayShipAddressValidationRequest":{"post":{"tags":["Exported Services"],"summary":"Address Validation Request","description":"Address Validation Request","operationId":"gatewayShipAddressValidationRequest","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service gatewayShipAddressValidationRequest","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.gatewayShipAddressValidationRequest"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.gatewayShipAddressValidationRequest.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Check for shopify order to approve

> Check for shopify order to approve

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.generateCustomerOrderUpdateLink":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"}},"description":"In Schema for service: generateCustomerOrderUpdateLink request"},"api.response.generateCustomerOrderUpdateLink.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"url":{"type":"string"}}}},"description":"Out Schema for service: generateCustomerOrderUpdateLink response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/generateCustomerOrderUpdateLink":{"post":{"tags":["Exported Services"],"summary":"Check for shopify order to approve","description":"Check for shopify order to approve","operationId":"generateCustomerOrderUpdateLink","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service generateCustomerOrderUpdateLink","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.generateCustomerOrderUpdateLink"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.generateCustomerOrderUpdateLink.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for generate manifest

> Service for generate manifest

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.generateManifests":{"required":["facilityId"],"type":"object","properties":{"carrierPartyId":{"type":"string"},"facilityId":{"type":"string"},"manifestGenerateServiceName":{"type":"string"}},"description":"In Schema for service: generateManifests request"},"api.response.generateManifests.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: generateManifests response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/generateManifests":{"post":{"tags":["Exported Services"],"summary":"Service for generate manifest","description":"Service for generate manifest","operationId":"generateManifests","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service generateManifests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.generateManifests"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.generateManifests.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## GET /services/getCODOrderRemainingTotal

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getCODOrderRemainingTotal":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"}},"description":"In Schema for service: getCODOrderRemainingTotal request"},"api.response.getCODOrderRemainingTotal.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"total":{"type":"number"}}}},"description":"Out Schema for service: getCODOrderRemainingTotal response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getCODOrderRemainingTotal":{"get":{"tags":["Exported Services"],"summary":"","description":"","operationId":"getCODOrderRemainingTotal","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getCODOrderRemainingTotal"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getCODOrderRemainingTotal.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Send a post request to run a DAG in airflow

> Send a post request to run a DAG in airflow

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getDAGRunStatus":{"required":["dagId","dagRunId"],"type":"object","properties":{"dagRunId":{"type":"string"},"dagId":{"type":"string"}},"description":"In Schema for service: getDAGRunStatus request"},"api.response.getDAGRunStatus.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: getDAGRunStatus response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getDAGRunStatus":{"get":{"tags":["Exported Services"],"summary":"Send a post request to run a DAG in airflow","description":"Send a post request to run a DAG in airflow","operationId":"getDAGRunStatus","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getDAGRunStatus"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getDAGRunStatus.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Get facilityId by identification type ID

> Get facilityId by identification type ID

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getFacilityIdByType":{"required":["identification"],"type":"object","properties":{"identification":{"type":"string"},"identificationType":{"type":"string"}},"description":"In Schema for service: getFacilityIdByType request"},"api.response.getFacilityIdByType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"facilityId":{"type":"string"}}}},"description":"Out Schema for service: getFacilityIdByType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getFacilityIdByType":{"get":{"tags":["Exported Services"],"summary":"Get facilityId by identification type ID","description":"Get facilityId by identification type ID","operationId":"getFacilityIdByType","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getFacilityIdByType"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getFacilityIdByType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Returns the geoPoint for country postal code

> Returns the geoPoint for country postal code

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getGeoPointForPostalCode":{"required":["countryCode","postalCode"],"type":"object","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"}},"description":"In Schema for service: getGeoPointForPostalCode request"},"api.response.getGeoPointForPostalCode.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"cacheKey":{"type":"string"},"geoPoint":{"type":"object"}}}},"description":"Out Schema for service: getGeoPointForPostalCode response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getGeoPointForPostalCode":{"get":{"tags":["Exported Services"],"summary":"Returns the geoPoint for country postal code","description":"Returns the geoPoint for country postal code","operationId":"getGeoPointForPostalCode","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getGeoPointForPostalCode"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getGeoPointForPostalCode.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Get Inventory Availability for a Product constrained by a facilityId

> Get Inventory Availability for a Product constrained by a facilityId

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getInventoryAvailableByFacility":{"required":["facilityId","productId"],"type":"object","properties":{"facilityId":{"type":"string"},"statusId":{"type":"string"},"productId":{"type":"string"},"useCache":{"type":"boolean"},"lotId":{"type":"string"}},"description":"In Schema for service: getInventoryAvailableByFacility request"},"api.response.getInventoryAvailableByFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"quantityOnHandTotal":{"type":"number"},"accountingQuantityTotal":{"type":"number"},"availableToPromiseTotal":{"type":"number"}}}},"description":"Out Schema for service: getInventoryAvailableByFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getInventoryAvailableByFacility":{"get":{"tags":["Exported Services"],"summary":"Get Inventory Availability for a Product constrained by a facilityId","description":"Get Inventory Availability for a Product constrained by a facilityId","operationId":"getInventoryAvailableByFacility","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getInventoryAvailableByFacility"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getInventoryAvailableByFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getInventoryAvailableByLocation":{"required":["facilityId","locationSeqId","productId"],"type":"object","properties":{"facilityId":{"type":"string"},"statusId":{"type":"string"},"productId":{"type":"string"},"useCache":{"type":"boolean"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: getInventoryAvailableByLocation request"},"api.response.getInventoryAvailableByLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"quantityOnHandTotal":{"type":"number"},"accountingQuantityTotal":{"type":"number"},"availableToPromiseTotal":{"type":"number"}}}},"description":"Out Schema for service: getInventoryAvailableByLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getInventoryAvailableByLocation":{"get":{"tags":["Exported Services"],"summary":"Get Inventory Availability for a Product constrained by a facility and location","description":"Get Inventory Availability for a Product constrained by a facility and location","operationId":"getInventoryAvailableByLocation","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getInventoryAvailableByLocation"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getInventoryAvailableByLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Get orderId by order identification type ID

> Get orderId by order identification type ID

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getOrderIdByType":{"required":["identification"],"type":"object","properties":{"identification":{"type":"string"},"identificationType":{"type":"string"}},"description":"In Schema for service: getOrderIdByType request"},"api.response.getOrderIdByType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderId":{"type":"string"}}}},"description":"Out Schema for service: getOrderIdByType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getOrderIdByType":{"get":{"tags":["Exported Services"],"summary":"Get orderId by order identification type ID","description":"Get orderId by order identification type ID","operationId":"getOrderIdByType","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getOrderIdByType"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getOrderIdByType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## GET /services/getProductFutureAtp

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getProductFutureAtp":{"required":["productId"],"type":"object","properties":{"isNewProduct":{"type":"string"},"productId":{"type":"string"}},"description":"In Schema for service: getProductFutureAtp request"},"api.response.getProductFutureAtp.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"futureAtp":{"type":"integer","format":"int32"}}}},"description":"Out Schema for service: getProductFutureAtp response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getProductFutureAtp":{"get":{"tags":["Exported Services"],"summary":"","description":"","operationId":"getProductFutureAtp","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getProductFutureAtp"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getProductFutureAtp.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Get Inventory Availability for a Product

> Get Inventory Availability for a Product

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getProductInventoryAvailable":{"required":["productId"],"type":"object","properties":{"ownerPartyId":{"type":"string"},"facilityId":{"type":"string"},"statusId":{"type":"string"},"productId":{"type":"string"},"useCache":{"type":"boolean"},"facilityTypeId":{"type":"string"},"containerId":{"type":"string"},"itemCondition":{"type":"string"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: getProductInventoryAvailable request"},"api.response.getProductInventoryAvailable.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"quantityOnHandTotal":{"type":"number"},"accountingQuantityTotal":{"type":"number"},"availableToPromiseTotal":{"type":"number"}}}},"description":"Out Schema for service: getProductInventoryAvailable response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getProductInventoryAvailable":{"get":{"tags":["Exported Services"],"summary":"Get Inventory Availability for a Product","description":"Get Inventory Availability for a Product","operationId":"getProductInventoryAvailable","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getProductInventoryAvailable"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getProductInventoryAvailable.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## GET /services/getProductOnlineAtp

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getProductOnlineAtp":{"required":["productStoreId"],"type":"object","properties":{"conditionMap":{"type":"object"},"idType":{"type":"string"},"productId":{"type":"string"},"facilityGroupId":{"type":"string"},"idValue":{"type":"string"},"productStoreId":{"type":"string"}},"description":"In Schema for service: getProductOnlineAtp request"},"api.response.getProductOnlineAtp.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"onlineAtp":{"type":"integer","format":"int32"}}}},"description":"Out Schema for service: getProductOnlineAtp response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getProductOnlineAtp":{"get":{"tags":["Exported Services"],"summary":"","description":"","operationId":"getProductOnlineAtp","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getProductOnlineAtp"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getProductOnlineAtp.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## GET /services/getServerTimeZone

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.response.getServerTimeZone.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"serverTimeZone":{"type":"string"}}}},"description":"Out Schema for service: getServerTimeZone response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getServerTimeZone":{"get":{"tags":["Exported Services"],"summary":"","description":"","operationId":"getServerTimeZone","parameters":[{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getServerTimeZone.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Main method to get shipping label from Third Party Shipping Services

> Main method to get shipping label from Third Party Shipping Services

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getShippingLabel":{"required":["shipmentId"],"type":"object","properties":{"carrierPartyId":{"type":"string"},"shipmentId":{"type":"string"}},"description":"In Schema for service: getShippingLabel request"},"api.response.getShippingLabel.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: getShippingLabel response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getShippingLabel":{"get":{"tags":["Exported Services"],"summary":"Main method to get shipping label from Third Party Shipping Services","description":"Main method to get shipping label from Third Party Shipping Services","operationId":"getShippingLabel","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getShippingLabel"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getShippingLabel.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Get Shopify draft order.

> Get Shopify draft order.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getShopifyDraftOrder":{"required":["draftOrderId","shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"draftOrderId":{"type":"integer","format":"int32"}},"description":"In Schema for service: getShopifyDraftOrder request"},"api.response.getShopifyDraftOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"response":{"type":"object"}}}},"description":"Out Schema for service: getShopifyDraftOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getShopifyDraftOrder":{"get":{"tags":["Exported Services"],"summary":"Get Shopify draft order.","description":"Get Shopify draft order.","operationId":"getShopifyDraftOrder","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getShopifyDraftOrder"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getShopifyDraftOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Get Shopify Webhooks created from API

> Get Shopify Webhooks created from API

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getShopifyWebhooks":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"}},"description":"In Schema for service: getShopifyWebhooks request"},"api.response.getShopifyWebhooks.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"webhooks":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: getShopifyWebhooks response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getShopifyWebhooks":{"get":{"tags":["Exported Services"],"summary":"Get Shopify Webhooks created from API","description":"Get Shopify Webhooks created from API","operationId":"getShopifyWebhooks","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getShopifyWebhooks"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getShopifyWebhooks.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

\
&#x20;           Gets a single user preference.\
&#x20;           If not found for the specific userLogin, find it for the \_NA\_ userlogin.\
&#x20;           If the value is DEFAULT, find the value in general.properties file.\
&#x20;      &#x20;
------------------

> \
> &#x20;           Gets a single user preference.\
> &#x20;           If not found for the specific userLogin, find it for the \_NA\_ userlogin.\
> &#x20;           If the value is DEFAULT, find the value in general.properties file.\
> &#x20;      &#x20;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.getUserPreference":{"required":["userPrefTypeId"],"type":"object","properties":{"userPrefGroupTypeId":{"type":"string"},"userPrefTypeId":{"type":"string"},"userPrefLoginId":{"type":"string"}},"description":"In Schema for service: getUserPreference request"},"api.response.getUserPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"userPrefMap":{"type":"object"}}}},"description":"Out Schema for service: getUserPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/getUserPreference":{"get":{"tags":["Exported Services"],"summary":"\n            Gets a single user preference.\n            If not found for the specific userLogin, find it for the _NA_ userlogin.\n            If the value is DEFAULT, find the value in general.properties file.\n        ","description":"\n            Gets a single user preference.\n            If not found for the specific userLogin, find it for the _NA_ userlogin.\n            If the value is DEFAULT, find the value in general.properties file.\n        ","operationId":"getUserPreference","parameters":[{"name":"inParams","in":"query","description":"Service In Parameters in JSON","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.getUserPreference"}}}},{"name":"Accept","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.getUserPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

This enhancement aims to streamline the data manager configuration process,\
&#x20;           enabling the efficient creation of multiple data objects using a single JSON file.\
&#x20;           The introduction of the \`importJsonListData\` service ensures flexibility and\
&#x20;           ease of use.\
&#x20;           This service will take the list of json data.\
&#x20;      &#x20;
------------------

> This enhancement aims to streamline the data manager configuration process,\
> &#x20;           enabling the efficient creation of multiple data objects using a single JSON file.\
> &#x20;           The introduction of the \`importJsonListData\` service ensures flexibility and\
> &#x20;           ease of use.\
> &#x20;           This service will take the list of json data.\
> &#x20;      &#x20;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.importJsonListData":{"required":["dataList"],"type":"object","properties":{"dataList":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: importJsonListData request"},"api.response.importJsonListData.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: importJsonListData response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/importJsonListData":{"post":{"tags":["Exported Services"],"summary":"This enhancement aims to streamline the data manager configuration process,\n            enabling the efficient creation of multiple data objects using a single JSON file.\n            The introduction of the `importJsonListData` service ensures flexibility and\n            ease of use.\n            This service will take the list of json data.\n        ","description":"This enhancement aims to streamline the data manager configuration process,\n            enabling the efficient creation of multiple data objects using a single JSON file.\n            The introduction of the `importJsonListData` service ensures flexibility and\n            ease of use.\n            This service will take the list of json data.\n        ","operationId":"importJsonListData","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service importJsonListData","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.importJsonListData"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.importJsonListData.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/importProductFacility

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.importProductFacility":{"type":"object","properties":{"allowPickup":{"type":"string"},"productSku":{"type":"string"},"reorderPoint":{"type":"string"},"idType":{"type":"string"},"facilityId":{"type":"string"},"productId":{"type":"string"},"facilityExternalId":{"type":"string"},"salesVelocity":{"type":"string"},"allowBrokering":{"type":"string"},"reorderQuantity":{"type":"string"},"maximumStock":{"type":"string"},"facilityMinimumStock":{"type":"string"}},"description":"In Schema for service: importProductFacility request"},"api.response.importProductFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: importProductFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/importProductFacility":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"importProductFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service importProductFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.importProductFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.importProductFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for fetching indexing instance details to Solr

> Service for fetching indexing instance details to Solr

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.indexDeploymentData":{"type":"object","properties":{"updateHandler":{"type":"string"},"coreName":{"type":"string"}},"description":"In Schema for service: indexDeploymentData request"},"api.response.indexDeploymentData.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: indexDeploymentData response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/indexDeploymentData":{"post":{"tags":["Exported Services"],"summary":"Service for fetching indexing instance details to Solr","description":"Service for fetching indexing instance details to Solr","operationId":"indexDeploymentData","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service indexDeploymentData","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.indexDeploymentData"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.indexDeploymentData.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for indexing instance details to Solr recieved from API call

> Service for indexing instance details to Solr recieved from API call

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.indexExternalDeploymentData":{"required":["deploymentData"],"type":"object","properties":{"updateHandler":{"type":"string"},"deploymentData":{"type":"object"},"coreName":{"type":"string"}},"description":"In Schema for service: indexExternalDeploymentData request"},"api.response.indexExternalDeploymentData.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: indexExternalDeploymentData response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/indexExternalDeploymentData":{"post":{"tags":["Exported Services"],"summary":"Service for indexing instance details to Solr recieved from API call","description":"Service for indexing instance details to Solr recieved from API call","operationId":"indexExternalDeploymentData","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service indexExternalDeploymentData","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.indexExternalDeploymentData"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.indexExternalDeploymentData.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service for indexing webhook error details to Solr

> Service for indexing webhook error details to Solr

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.indexWebhookErrorMessage":{"type":"object","properties":{"payload":{"type":"object"},"remoteUrl":{"type":"string"},"comment":{"type":"string"},"topicEnumId":{"type":"string"},"coreName":{"type":"string"}},"description":"In Schema for service: indexWebhookErrorMessage request"},"api.response.indexWebhookErrorMessage.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: indexWebhookErrorMessage response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/indexWebhookErrorMessage":{"post":{"tags":["Exported Services"],"summary":"Service for indexing webhook error details to Solr","description":"Service for indexing webhook error details to Solr","operationId":"indexWebhookErrorMessage","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service indexWebhookErrorMessage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.indexWebhookErrorMessage"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.indexWebhookErrorMessage.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Inventory update service triggers on Shopify Inventory Level Update webhook

> Inventory update service triggers on Shopify Inventory Level Update webhook

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.inventoryLevelUpdateFromShopify":{"required":["available","inventory_item_id","location_id","shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"inventory_item_id":{"type":"integer","format":"int32"},"available":{"type":"integer","format":"int32"},"location_id":{"type":"integer","format":"int32"}},"description":"In Schema for service: inventoryLevelUpdateFromShopify request"},"api.response.inventoryLevelUpdateFromShopify.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: inventoryLevelUpdateFromShopify response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/inventoryLevelUpdateFromShopify":{"post":{"tags":["Exported Services"],"summary":"Inventory update service triggers on Shopify Inventory Level Update webhook","description":"Inventory update service triggers on Shopify Inventory Level Update webhook","operationId":"inventoryLevelUpdateFromShopify","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service inventoryLevelUpdateFromShopify","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.inventoryLevelUpdateFromShopify"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.inventoryLevelUpdateFromShopify.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/moveItemToParkingFacility

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.moveItemToParkingFacility":{"required":["fromShipGroupSeqId","orderId","orderItemSeqId","toFacilityId"],"type":"object","properties":{"fromShipGroupSeqId":{"type":"string"},"orderItemSeqId":{"type":"string"},"comments":{"type":"string"},"orderId":{"type":"string"},"changeReasonEnumId":{"type":"string"},"toFacilityId":{"type":"string"}},"description":"In Schema for service: moveItemToParkingFacility request"},"api.response.moveItemToParkingFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: moveItemToParkingFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/moveItemToParkingFacility":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"moveItemToParkingFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service moveItemToParkingFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.moveItemToParkingFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.moveItemToParkingFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Check if fulfillment started for item and then reject it

> Check if fulfillment started for item and then reject it

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.oldCheckAndRejectOrderItem":{"required":["orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"excludeOrderFacilityDuration":{"type":"string"},"orderId":{"type":"string"},"rejectionComments":{"type":"string"},"rejectionReason":{"type":"string"},"notify":{"type":"boolean"}},"description":"In Schema for service: oldCheckAndRejectOrderItem request"},"api.response.oldCheckAndRejectOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: oldCheckAndRejectOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/oldCheckAndRejectOrderItem":{"post":{"tags":["Exported Services"],"summary":"Check if fulfillment started for item and then reject it","description":"Check if fulfillment started for item and then reject it","operationId":"oldCheckAndRejectOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service oldCheckAndRejectOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.oldCheckAndRejectOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.oldCheckAndRejectOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reject Order Item

> Reject Order Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.oldRejectOrderItem":{"type":"object","properties":{"payload":{"type":"object"},"rejectedComponents":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: oldRejectOrderItem request"},"api.response.oldRejectOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"payload":{"type":"object"},"rejectedItemsList":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: oldRejectOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/oldRejectOrderItem":{"post":{"tags":["Exported Services"],"summary":"Reject Order Item","description":"Reject Order Item","operationId":"oldRejectOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service oldRejectOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.oldRejectOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.oldRejectOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reject Order Line Item

> Reject Order Line Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.oldRejectOrderItems":{"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: oldRejectOrderItems request"},"api.response.oldRejectOrderItems.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderId":{"type":"string"},"payload":{"type":"object"},"rejectedItemsList":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: oldRejectOrderItems response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/oldRejectOrderItems":{"post":{"tags":["Exported Services"],"summary":"Reject Order Line Item","description":"Reject Order Line Item","operationId":"oldRejectOrderItems","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service oldRejectOrderItems","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.oldRejectOrderItems"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.oldRejectOrderItems.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.orderDataSetup":{"type":"object","properties":{"shippingCity":{"type":"string"},"lastName":{"type":"string"},"externalPlacingFacilityId":{"type":"string"},"orderId":{"type":"string"},"orderTypeId":{"type":"string"},"originExternalFacilityId":{"type":"string"},"shippingPostalCode":{"type":"string"},"shippingAddress2":{"type":"string"},"externalFacilityId":{"type":"string"},"shippingAddress1":{"type":"string"},"shippingTax":{"type":"string"},"externalProductStoreId":{"type":"string"},"unitListPrice":{"type":"string"},"shippingCountry":{"type":"string"},"itemStatus":{"type":"string"},"salesChannelEnumCode":{"type":"string"},"customerId":{"type":"string"},"productStoreId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"orderItemTypeId":{"type":"string"},"orderName":{"type":"string"},"unitPrice":{"type":"string"},"quantity":{"type":"string"},"idType":{"type":"string"},"facilityId":{"type":"string"},"productId":{"type":"string"},"shippingCharges":{"type":"string"},"grandTotal":{"type":"string"},"customerExternalId":{"type":"string"},"externalId":{"type":"string"},"idValue":{"type":"string"},"shippingPhone":{"type":"string"},"placingFacilityId":{"type":"string"},"orderIdentification":{"type":"string"},"itemTotalDiscount":{"type":"string"},"originFacilityId":{"type":"string"},"carrierPartyId":{"type":"string"},"firstName":{"type":"string"},"itemExternalId":{"type":"string"},"paymentMethod":{"type":"string"},"shippingState":{"type":"string"},"itemTax":{"type":"string"},"orderDate":{"type":"string"},"shippingEmail":{"type":"string"}},"description":"In Schema for service: orderDataSetup request"},"api.response.orderDataSetup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: orderDataSetup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/orderDataSetup":{"post":{"tags":["Exported Services"],"summary":"To import order usign csv (Either posted by script or uploaded from browser)","description":"To import order usign csv (Either posted by script or uploaded from browser)","operationId":"orderDataSetup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service orderDataSetup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.orderDataSetup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.orderDataSetup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

\
&#x20;           The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities.\
&#x20;           This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed.\
&#x20;           Below are the key functionalities of this service:\
\
&#x20;           \- Item Allocation: Allocates items to a specified facility within an order.\
&#x20;           \- Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.\
&#x20;           \- Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.\
&#x20;           \- Ship Group Management: Moves items to the appropriate ship group as per allocation.\
&#x20;           \- Item Reservation: Executes reservation of items as part of the allocation process.\
&#x20;           \- 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.\
\
&#x20;           Input Parameters:\
&#x20;           The service accepts the following input parameters for processing:\
\
&#x20;           \- orderId: The unique identifier of the order for which allocation is being performed.\
&#x20;           \- externalOrderId: An optional external ID associated with the order.\
&#x20;           \- facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:\
&#x20;               \- facilityId: Identifier of the facility to which items are being allocated.\
&#x20;               \- facilityExternalId: An optional external ID for the facility.\
&#x20;               \- items: A list of item objects, each comprising:\
&#x20;                   \- orderItemSeqId: Sequence ID of the order item.\
&#x20;                   \- autoCancelDate: An optional date when an order item should be automatically canceled if not processed.\
&#x20;                   \- clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item\
&#x20;                   \- orderItemExternalId: An optional external ID for the order item.\
&#x20;                   \- quantity: Number of units of the item to allocate.\
\
&#x20;           Sample JSON Input:\
&#x20;           json\
&#x20;           \`\`\`\
&#x20;           {\
&#x20;               "orderId": "105",\
&#x20;               "externalOrderId": "",\
&#x20;               "facilityAllocation": \[\
&#x20;                   {\
&#x20;                       "facilityId": "1",\
&#x20;                       "items": \[\
&#x20;                           {\
&#x20;                               "orderItemSeqId": "00101",\
&#x20;                               "quantity": 1\
&#x20;                           },\
&#x20;                           {\
&#x20;                               "orderItemSeqId": "00102",\
&#x20;                               "quantity": 1\
&#x20;                           }\
&#x20;                   ]\
&#x20;               },\
&#x20;               {\
&#x20;                   "facilityId": "10",\
&#x20;                       "items": \[\
&#x20;                           {\
&#x20;                               "orderItemSeqId": "00103",\
&#x20;                               "orderItemExternalId": "",\
&#x20;                               "quantity": 1\
&#x20;                           }\
&#x20;                       ]\
&#x20;                   }\
&#x20;               ]\
&#x20;           }\
&#x20;           \`\`\`\
&#x20;           Service Operation:\
\
&#x20;           Upon receiving the input parameters, the service will:\
&#x20;           \- Validate all input data for correctness and completeness.\
&#x20;           \- Check the current facility status of each item.\
&#x20;           \- Allocate items to the specified facilities as per the input.\
&#x20;           \- Perform necessary item reservations.\
&#x20;           \- Return a success response if an item is already allocated to the specified facility.\
&#x20;           \- In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.\
\
&#x20;           This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.\
&#x20;      &#x20;
------------------

> \
> &#x20;           The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities.\
> &#x20;           This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed.\
> &#x20;           Below are the key functionalities of this service:\
> \
> &#x20;           \- Item Allocation: Allocates items to a specified facility within an order.\
> &#x20;           \- Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.\
> &#x20;           \- Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.\
> &#x20;           \- Ship Group Management: Moves items to the appropriate ship group as per allocation.\
> &#x20;           \- Item Reservation: Executes reservation of items as part of the allocation process.\
> &#x20;           \- 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.\
> \
> &#x20;           Input Parameters:\
> &#x20;           The service accepts the following input parameters for processing:\
> \
> &#x20;           \- orderId: The unique identifier of the order for which allocation is being performed.\
> &#x20;           \- externalOrderId: An optional external ID associated with the order.\
> &#x20;           \- facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:\
> &#x20;               \- facilityId: Identifier of the facility to which items are being allocated.\
> &#x20;               \- facilityExternalId: An optional external ID for the facility.\
> &#x20;               \- items: A list of item objects, each comprising:\
> &#x20;                   \- orderItemSeqId: Sequence ID of the order item.\
> &#x20;                   \- autoCancelDate: An optional date when an order item should be automatically canceled if not processed.\
> &#x20;                   \- clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item\
> &#x20;                   \- orderItemExternalId: An optional external ID for the order item.\
> &#x20;                   \- quantity: Number of units of the item to allocate.\
> \
> &#x20;           Sample JSON Input:\
> &#x20;           json\
> &#x20;           \`\`\`\
> &#x20;           {\
> &#x20;               "orderId": "105",\
> &#x20;               "externalOrderId": "",\
> &#x20;               "facilityAllocation": \[\
> &#x20;                   {\
> &#x20;                       "facilityId": "1",\
> &#x20;                       "items": \[\
> &#x20;                           {\
> &#x20;                               "orderItemSeqId": "00101",\
> &#x20;                               "quantity": 1\
> &#x20;                           },\
> &#x20;                           {\
> &#x20;                               "orderItemSeqId": "00102",\
> &#x20;                               "quantity": 1\
> &#x20;                           }\
> &#x20;                   ]\
> &#x20;               },\
> &#x20;               {\
> &#x20;                   "facilityId": "10",\
> &#x20;                       "items": \[\
> &#x20;                           {\
> &#x20;                               "orderItemSeqId": "00103",\
> &#x20;                               "orderItemExternalId": "",\
> &#x20;                               "quantity": 1\
> &#x20;                           }\
> &#x20;                       ]\
> &#x20;                   }\
> &#x20;               ]\
> &#x20;           }\
> &#x20;           \`\`\`\
> &#x20;           Service Operation:\
> \
> &#x20;           Upon receiving the input parameters, the service will:\
> &#x20;           \- Validate all input data for correctness and completeness.\
> &#x20;           \- Check the current facility status of each item.\
> &#x20;           \- Allocate items to the specified facilities as per the input.\
> &#x20;           \- Perform necessary item reservations.\
> &#x20;           \- Return a success response if an item is already allocated to the specified facility.\
> &#x20;           \- In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.\
> \
> &#x20;           This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.\
> &#x20;      &#x20;

````json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.orderFulfillmentAllocation":{"required":["facilityAllocation"],"type":"object","properties":{"orderId":{"type":"string"},"externalOrderId":{"type":"string"},"facilityAllocation":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: orderFulfillmentAllocation request"},"api.response.orderFulfillmentAllocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: orderFulfillmentAllocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/orderFulfillmentAllocation":{"post":{"tags":["Exported Services"],"summary":"\n            The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities.\n            This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed.\n            Below are the key functionalities of this service:\n\n            - Item Allocation: Allocates items to a specified facility within an order.\n            - Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.\n            - Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.\n            - Ship Group Management: Moves items to the appropriate ship group as per allocation.\n            - Item Reservation: Executes reservation of items as part of the allocation process.\n            - 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.\n\n            Input Parameters:\n            The service accepts the following input parameters for processing:\n\n            - orderId: The unique identifier of the order for which allocation is being performed.\n            - externalOrderId: An optional external ID associated with the order.\n            - facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:\n                - facilityId: Identifier of the facility to which items are being allocated.\n                - facilityExternalId: An optional external ID for the facility.\n                - items: A list of item objects, each comprising:\n                    - orderItemSeqId: Sequence ID of the order item.\n                    - autoCancelDate: An optional date when an order item should be automatically canceled if not processed.\n                    - clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item\n                    - orderItemExternalId: An optional external ID for the order item.\n                    - quantity: Number of units of the item to allocate.\n\n            Sample JSON Input:\n            json\n            ```\n            {\n                \"orderId\": \"105\",\n                \"externalOrderId\": \"\",\n                \"facilityAllocation\": [\n                    {\n                        \"facilityId\": \"1\",\n                        \"items\": [\n                            {\n                                \"orderItemSeqId\": \"00101\",\n                                \"quantity\": 1\n                            },\n                            {\n                                \"orderItemSeqId\": \"00102\",\n                                \"quantity\": 1\n                            }\n                    ]\n                },\n                {\n                    \"facilityId\": \"10\",\n                        \"items\": [\n                            {\n                                \"orderItemSeqId\": \"00103\",\n                                \"orderItemExternalId\": \"\",\n                                \"quantity\": 1\n                            }\n                        ]\n                    }\n                ]\n            }\n            ```\n            Service Operation:\n\n            Upon receiving the input parameters, the service will:\n            - Validate all input data for correctness and completeness.\n            - Check the current facility status of each item.\n            - Allocate items to the specified facilities as per the input.\n            - Perform necessary item reservations.\n            - Return a success response if an item is already allocated to the specified facility.\n            - In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.\n\n            This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.\n        ","description":"\n            The Facility Item Allocation Service is designed to efficiently manage and allocate items within an order to specific facilities.\n            This service is crucial for ensuring that items are moved to the appropriate ship group and that reservations are accurately performed.\n            Below are the key functionalities of this service:\n\n            - Item Allocation: Allocates items to a specified facility within an order.\n            - Add Auto Cancel Date: Set a specific date when an order item should be automatically canceled if not processed.\n            - Remove Auto Cancel Date: If an order item no longer requires an automatic cancellation, you can easily remove the set auto cancel date.\n            - Ship Group Management: Moves items to the appropriate ship group as per allocation.\n            - Item Reservation: Executes reservation of items as part of the allocation process.\n            - 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.\n\n            Input Parameters:\n            The service accepts the following input parameters for processing:\n\n            - orderId: The unique identifier of the order for which allocation is being performed.\n            - externalOrderId: An optional external ID associated with the order.\n            - facilityAllocation: A collection of objects detailing the allocation of items to specific facilities. Each object in this array includes:\n                - facilityId: Identifier of the facility to which items are being allocated.\n                - facilityExternalId: An optional external ID for the facility.\n                - items: A list of item objects, each comprising:\n                    - orderItemSeqId: Sequence ID of the order item.\n                    - autoCancelDate: An optional date when an order item should be automatically canceled if not processed.\n                    - clearAutoCancelDate: Allows you to remove the auto cancel date set on an order item\n                    - orderItemExternalId: An optional external ID for the order item.\n                    - quantity: Number of units of the item to allocate.\n\n            Sample JSON Input:\n            json\n            ```\n            {\n                \"orderId\": \"105\",\n                \"externalOrderId\": \"\",\n                \"facilityAllocation\": [\n                    {\n                        \"facilityId\": \"1\",\n                        \"items\": [\n                            {\n                                \"orderItemSeqId\": \"00101\",\n                                \"quantity\": 1\n                            },\n                            {\n                                \"orderItemSeqId\": \"00102\",\n                                \"quantity\": 1\n                            }\n                    ]\n                },\n                {\n                    \"facilityId\": \"10\",\n                        \"items\": [\n                            {\n                                \"orderItemSeqId\": \"00103\",\n                                \"orderItemExternalId\": \"\",\n                                \"quantity\": 1\n                            }\n                        ]\n                    }\n                ]\n            }\n            ```\n            Service Operation:\n\n            Upon receiving the input parameters, the service will:\n            - Validate all input data for correctness and completeness.\n            - Check the current facility status of each item.\n            - Allocate items to the specified facilities as per the input.\n            - Perform necessary item reservations.\n            - Return a success response if an item is already allocated to the specified facility.\n            - In cases where an item is located in a virtual facility or if other error conditions arise, the service will throw an error.\n\n            This service ensures streamlined and error-free allocation of items to facilities, enhancing the efficiency of order processing and fulfillment.\n        ","operationId":"orderFulfillmentAllocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service orderFulfillmentAllocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.orderFulfillmentAllocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.orderFulfillmentAllocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
````

## Mark picklist bin items as Picked

> Mark picklist bin items as Picked

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.packStoreFulfillmentOrder":{"required":["orderId","picklistBinId"],"type":"object","properties":{"orderId":{"type":"string"},"picklistBinId":{"type":"string"}},"description":"In Schema for service: packStoreFulfillmentOrder request"},"api.response.packStoreFulfillmentOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: packStoreFulfillmentOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/packStoreFulfillmentOrder":{"post":{"tags":["Exported Services"],"summary":"Mark picklist bin items as Picked","description":"Mark picklist bin items as Picked","operationId":"packStoreFulfillmentOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service packStoreFulfillmentOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.packStoreFulfillmentOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.packStoreFulfillmentOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Imports picklist And Picklist Item

> Imports picklist And Picklist Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.picklistDataSetup":{"type":"object","properties":{"inventoryItemId":{"type":"string"},"orderItemSeqId":{"type":"string"},"picklistId":{"type":"string"},"quantity":{"type":"string"},"facilityId":{"type":"string"},"pickerIds":{"type":"array","items":{"type":"string"}},"picked":{"type":"string"},"orderId":{"type":"string"},"externalId":{"type":"string"},"shipGroupSeqId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"itemStatusId":{"type":"string"},"binLocationNumber":{"type":"integer","format":"int32"}},"description":"In Schema for service: picklistDataSetup request"},"api.response.picklistDataSetup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"picklistId":{"type":"string"},"picklistBinId":{"type":"string"}}}},"description":"Out Schema for service: picklistDataSetup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/picklistDataSetup":{"post":{"tags":["Exported Services"],"summary":"Imports picklist And Picklist Item","description":"Imports picklist And Picklist Item","operationId":"picklistDataSetup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service picklistDataSetup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.picklistDataSetup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.picklistDataSetup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Pull And Report Entity Sync Data

> Pull And Report Entity Sync Data

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.pullAndReportEntitySyncData":{"required":["entitySyncId"],"type":"object","properties":{"delegatorName":{"type":"string"},"entitySyncId":{"type":"string"},"toStoreUpdated":{"type":"integer","format":"int32"},"toCreateInserted":{"type":"integer","format":"int32"},"toCreateUpdated":{"type":"integer","format":"int32"},"toCreateNotUpdated":{"type":"integer","format":"int32"},"toRemoveAlreadyDeleted":{"type":"integer","format":"int32"},"toStoreNotUpdated":{"type":"integer","format":"int32"},"toRemoveDeleted":{"type":"integer","format":"int32"},"toStoreInserted":{"type":"integer","format":"int32"},"startDate":{"type":"string","format":"date"}},"description":"In Schema for service: pullAndReportEntitySyncData request"},"api.response.pullAndReportEntitySyncData.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"valuesToStore":{"type":"array","items":{"type":"string"}},"keysToRemove":{"type":"array","items":{"type":"string"}},"valuesToCreate":{"type":"array","items":{"type":"string"}},"startDate":{"type":"string","format":"date"}}}},"description":"Out Schema for service: pullAndReportEntitySyncData response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/pullAndReportEntitySyncData":{"post":{"tags":["Exported Services"],"summary":"Pull And Report Entity Sync Data","description":"Pull And Report Entity Sync Data","operationId":"pullAndReportEntitySyncData","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service pullAndReportEntitySyncData","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.pullAndReportEntitySyncData"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.pullAndReportEntitySyncData.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service to reship completed order items

> Service to reship completed order items

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.reShipOrderItems":{"required":["orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"array","items":{"type":"string"}},"orderId":{"type":"string"}},"description":"In Schema for service: reShipOrderItems request"},"api.response.reShipOrderItems.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"originalOrderId":{"type":"string"},"orderId":{"type":"string"}}}},"description":"Out Schema for service: reShipOrderItems response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/reShipOrderItems":{"post":{"tags":["Exported Services"],"summary":"Service to reship completed order items","description":"Service to reship completed order items","operationId":"reShipOrderItems","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service reShipOrderItems","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.reShipOrderItems"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.reShipOrderItems.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Recieve Incoming Shipment and push Inventory on Shopify

> Recieve Incoming Shipment and push Inventory on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.receiveAndUpdateInventoryToShopify":{"required":["shipmentId","shopId"],"type":"object","properties":{"shipmentId":{"type":"string"},"limit":{"type":"integer","format":"int32"},"shopId":{"type":"string"}},"description":"In Schema for service: receiveAndUpdateInventoryToShopify request"},"api.response.receiveAndUpdateInventoryToShopify.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: receiveAndUpdateInventoryToShopify response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/receiveAndUpdateInventoryToShopify":{"post":{"tags":["Exported Services"],"summary":"Recieve Incoming Shipment and push Inventory on Shopify","description":"Recieve Incoming Shipment and push Inventory on Shopify","operationId":"receiveAndUpdateInventoryToShopify","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service receiveAndUpdateInventoryToShopify","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.receiveAndUpdateInventoryToShopify"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.receiveAndUpdateInventoryToShopify.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## This service is used to record inventory variance&#x20;

> This service is used to record inventory variance&#x20;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.recordInventoryCount":{"required":["facilityId"],"type":"object","properties":{"reason":{"type":"string"},"comments":{"type":"string"},"quantity":{"type":"string"},"facilityId":{"type":"string"},"idType":{"type":"string"},"productId":{"type":"string"},"idValue":{"type":"string"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: recordInventoryCount request"},"api.response.recordInventoryCount.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: recordInventoryCount response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/recordInventoryCount":{"post":{"tags":["Exported Services"],"summary":"This service is used to record inventory variance ","description":"This service is used to record inventory variance ","operationId":"recordInventoryCount","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service recordInventoryCount","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.recordInventoryCount"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.recordInventoryCount.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/recordProductVariance

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.recordProductVariance":{"type":"object","properties":{"orderItemSeqId":{"type":"string"},"varianceReasonId":{"type":"string"},"comments":{"type":"string"},"quantity":{"type":"number"},"facilityId":{"type":"string"},"productId":{"type":"string"},"orderId":{"type":"string"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: recordProductVariance request"},"api.response.recordProductVariance.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: recordProductVariance response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/recordProductVariance":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"recordProductVariance","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service recordProductVariance","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.recordProductVariance"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.recordProductVariance.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reject in progress shipment item.

> Reject in progress shipment item.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.rejectFulfillmentReadyOrderItem":{"required":["facilityId","items"],"type":"object","properties":{"affectQOH":{"type":"boolean"},"excludeOrderFacilityDuration":{"type":"integer","format":"int32"},"facilityId":{"type":"string"},"rejectAllRelatedShipment":{"type":"string"},"rejectEntireShipment":{"type":"string"},"items":{"type":"array","items":{"type":"string"}},"defaultReason":{"type":"string"}},"description":"In Schema for service: rejectFulfillmentReadyOrderItem request"},"api.response.rejectFulfillmentReadyOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: rejectFulfillmentReadyOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/rejectFulfillmentReadyOrderItem":{"post":{"tags":["Exported Services"],"summary":"Reject in progress shipment item.","description":"Reject in progress shipment item.","operationId":"rejectFulfillmentReadyOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service rejectFulfillmentReadyOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.rejectFulfillmentReadyOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.rejectFulfillmentReadyOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reject Order Item

> Reject Order Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.rejectOrderItem":{"type":"object","properties":{"payload":{"type":"object"},"rejectedComponents":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: rejectOrderItem request"},"api.response.rejectOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"payload":{"type":"object"},"rejectedItemsList":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: rejectOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/rejectOrderItem":{"post":{"tags":["Exported Services"],"summary":"Reject Order Item","description":"Reject Order Item","operationId":"rejectOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service rejectOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.rejectOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.rejectOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reject Order Line Item

> Reject Order Line Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.rejectOrderItems":{"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: rejectOrderItems request"},"api.response.rejectOrderItems.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderId":{"type":"string"},"payload":{"type":"object"},"rejectedItemsList":{"type":"array","items":{"type":"string"}}}}},"description":"Out Schema for service: rejectOrderItems response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/rejectOrderItems":{"post":{"tags":["Exported Services"],"summary":"Reject Order Line Item","description":"Reject Order Line Item","operationId":"rejectOrderItems","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service rejectOrderItems","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.rejectOrderItems"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.rejectOrderItems.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Cancel reservations and if fulfillent started cancel shipment also.

> Cancel reservations and if fulfillent started cancel shipment also.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.rejectTransferOrderItem":{"required":["orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"}},"description":"In Schema for service: rejectTransferOrderItem request"},"api.response.rejectTransferOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: rejectTransferOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/rejectTransferOrderItem":{"post":{"tags":["Exported Services"],"summary":"Cancel reservations and if fulfillent started cancel shipment also.","description":"Cancel reservations and if fulfillent started cancel shipment also.","operationId":"rejectTransferOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service rejectTransferOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.rejectTransferOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.rejectTransferOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service to release Order Item from one facility to another

> Service to release Order Item from one facility to another

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.releaseOrderItem":{"required":["orderId","orderItemSeqId","toFacilityId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"routerUserLogin":{"type":"string"},"fromFacilityId":{"type":"string"},"orderId":{"type":"string"},"changeReasonEnumId":{"type":"string"},"toFacilityId":{"type":"string"}},"description":"In Schema for service: releaseOrderItem request"},"api.response.releaseOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shipGroupSeqId":{"type":"string"}}}},"description":"Out Schema for service: releaseOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/releaseOrderItem":{"post":{"tags":["Exported Services"],"summary":"Service to release Order Item from one facility to another","description":"Service to release Order Item from one facility to another","operationId":"releaseOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service releaseOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.releaseOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.releaseOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Wrapper Service For Removing Category Products

> Wrapper Service For Removing Category Products

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.removeCategoryProducts":{"required":["fromDate","productCategoryId","productId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"productCategoryId":{"type":"string"},"productId":{"type":"string"}},"description":"In Schema for service: removeCategoryProducts request"},"api.response.removeCategoryProducts.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: removeCategoryProducts response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/removeCategoryProducts":{"post":{"tags":["Exported Services"],"summary":"Wrapper Service For Removing Category Products","description":"Wrapper Service For Removing Category Products","operationId":"removeCategoryProducts","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service removeCategoryProducts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.removeCategoryProducts"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.removeCategoryProducts.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Remove firebase client registration token

> Remove firebase client registration token

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.removeClientRegistrationToken":{"required":["applicationId","deviceId"],"type":"object","properties":{"applicationId":{"type":"string"},"deviceId":{"type":"string"}},"description":"In Schema for service: removeClientRegistrationToken request"},"api.response.removeClientRegistrationToken.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: removeClientRegistrationToken response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/removeClientRegistrationToken":{"post":{"tags":["Exported Services"],"summary":"Remove firebase client registration token","description":"Remove firebase client registration token","operationId":"removeClientRegistrationToken","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service removeClientRegistrationToken","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.removeClientRegistrationToken"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.removeClientRegistrationToken.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Remove Facility From FacilityGroup

> Remove Facility From FacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.removeFacilityFromGroup":{"required":["facilityGroupId","facilityId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"facilityGroupId":{"type":"string"}},"description":"In Schema for service: removeFacilityFromGroup request"},"api.response.removeFacilityFromGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: removeFacilityFromGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/removeFacilityFromGroup":{"post":{"tags":["Exported Services"],"summary":"Remove Facility From FacilityGroup","description":"Remove Facility From FacilityGroup","operationId":"removeFacilityFromGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service removeFacilityFromGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.removeFacilityFromGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.removeFacilityFromGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Removing association of a Party from Facility

> Removing association of a Party from Facility

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.removePartyFromFacility":{"required":["facilityId","fromDate","partyId","roleTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"roleTypeId":{"type":"string"},"facilityId":{"type":"string"},"partyId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: removePartyFromFacility request"},"api.response.removePartyFromFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: removePartyFromFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/removePartyFromFacility":{"post":{"tags":["Exported Services"],"summary":"Removing association of a Party from Facility","description":"Removing association of a Party from Facility","operationId":"removePartyFromFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service removePartyFromFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.removePartyFromFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.removePartyFromFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/removePartyUserPermission

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.removePartyUserPermission":{"required":["groupId","userLoginId"],"type":"object","properties":{"userLoginId":{"type":"string"},"groupId":{"type":"string"}},"description":"In Schema for service: removePartyUserPermission request"},"api.response.removePartyUserPermission.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"userLoginId":{"type":"string"}}}},"description":"Out Schema for service: removePartyUserPermission response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/removePartyUserPermission":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"removePartyUserPermission","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service removePartyUserPermission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.removePartyUserPermission"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.removePartyUserPermission.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Remove existing webhook on Shopify

> Remove existing webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.removeShopifyWebhook":{"required":["shopifyConfigId","webhookId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"webhookId":{"type":"integer","format":"int32"}},"description":"In Schema for service: removeShopifyWebhook request"},"api.response.removeShopifyWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: removeShopifyWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/removeShopifyWebhook":{"post":{"tags":["Exported Services"],"summary":"Remove existing webhook on Shopify","description":"Remove existing webhook on Shopify","operationId":"removeShopifyWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service removeShopifyWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.removeShopifyWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.removeShopifyWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reset Password

> Reset Password

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.resetPassword":{"type":"object","properties":{"userLoginId":{"type":"string"},"newPasswordVerify":{"type":"string"},"passwordHint":{"type":"string"},"newPassword":{"type":"string"},"requirePasswordChange":{"type":"string"},"currentPassword":{"type":"string"}},"description":"In Schema for service: resetPassword request"},"api.response.resetPassword.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"updatedUserLogin":{"type":"object","properties":{"lastUpdatedStamp":{"type":"string","description":"lastUpdatedStamp","format":"date"},"isExternal":{"type":"string","description":"isExternal"},"passwordHint":{"type":"string","description":"passwordHint"},"createdTxStamp":{"type":"string","description":"createdTxStamp","format":"date"},"createdStamp":{"type":"string","description":"createdStamp","format":"date"},"externalAuthId":{"type":"string","description":"externalAuthId"},"lastUpdatedTxStamp":{"type":"string","description":"lastUpdatedTxStamp","format":"date"},"lastTimeZone":{"type":"string","description":"lastTimeZone"},"enabled":{"type":"string","description":"enabled"},"lastLocale":{"type":"string","description":"lastLocale"},"currentPassword":{"type":"string","description":"currentPassword"},"userLoginId":{"type":"string","description":"userLoginId"},"isSystem":{"type":"string","description":"isSystem"},"disabledDateTime":{"type":"string","description":"disabledDateTime","format":"date"},"disabledBy":{"type":"string","description":"disabledBy"},"hasLoggedOut":{"type":"string","description":"hasLoggedOut"},"userLdapDn":{"type":"string","description":"userLdapDn"},"requirePasswordChange":{"type":"string","description":"requirePasswordChange"},"lastCurrencyUom":{"type":"string","description":"lastCurrencyUom"},"partyId":{"type":"string","description":"partyId"}}}}}},"description":"Out Schema for service: resetPassword response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/resetPassword":{"post":{"tags":["Exported Services"],"summary":"Reset Password","description":"Reset Password","operationId":"resetPassword","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service resetPassword","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.resetPassword"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.resetPassword.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Reset all pickers on picklist.

> Reset all pickers on picklist.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.resetPicker":{"required":["pickerIds","picklistId"],"type":"object","properties":{"picklistId":{"type":"string"},"pickerIds":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: resetPicker request"},"api.response.resetPicker.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: resetPicker response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/resetPicker":{"post":{"tags":["Exported Services"],"summary":"Reset all pickers on picklist.","description":"Reset all pickers on picklist.","operationId":"resetPicker","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service resetPicker","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.resetPicker"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.resetPicker.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Send order Webhook message using Webhook Config.

> Send order Webhook message using Webhook Config.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.sendOrderWebhook":{"required":["orderId","topicEnumId"],"type":"object","properties":{"orderId":{"type":"string"},"topicEnumId":{"type":"string"}},"description":"In Schema for service: sendOrderWebhook request"},"api.response.sendOrderWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: sendOrderWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/sendOrderWebhook":{"post":{"tags":["Exported Services"],"summary":"Send order Webhook message using Webhook Config.","description":"Send order Webhook message using Webhook Config.","operationId":"sendOrderWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service sendOrderWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.sendOrderWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.sendOrderWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Send a pickup scheduled notification for all type of shipment.

> Send a pickup scheduled notification for all type of shipment.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.sendPickupScheduledNotification":{"required":["shipmentId"],"type":"object","properties":{"emailType":{"type":"string"},"shipmentId":{"type":"string"}},"description":"In Schema for service: sendPickupScheduledNotification request"},"api.response.sendPickupScheduledNotification.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: sendPickupScheduledNotification response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/sendPickupScheduledNotification":{"post":{"tags":["Exported Services"],"summary":"Send a pickup scheduled notification for all type of shipment.","description":"Send a pickup scheduled notification for all type of shipment.","operationId":"sendPickupScheduledNotification","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service sendPickupScheduledNotification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.sendPickupScheduledNotification"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.sendPickupScheduledNotification.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Send a ready to pick up item notification for STOREPICKUP type

> Send a ready to pick up item notification for STOREPICKUP type

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.sendReadyToPickupItemNotification":{"required":["shipmentId"],"type":"object","properties":{"emailType":{"type":"string"},"shipmentId":{"type":"string"}},"description":"In Schema for service: sendReadyToPickupItemNotification request"},"api.response.sendReadyToPickupItemNotification.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: sendReadyToPickupItemNotification response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/sendReadyToPickupItemNotification":{"post":{"tags":["Exported Services"],"summary":"Send a ready to pick up item notification for STOREPICKUP type","description":"Send a ready to pick up item notification for STOREPICKUP type","operationId":"sendReadyToPickupItemNotification","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service sendReadyToPickupItemNotification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.sendReadyToPickupItemNotification"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.sendReadyToPickupItemNotification.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

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

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

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.setCustomerDefaultStore":{"required":["customerId","facilityId"],"type":"object","properties":{"facilityId":{"type":"string"},"customerId":{"type":"string"},"shopDomain":{"type":"string"},"shopifyShopId":{"type":"string"}},"description":"In Schema for service: setCustomerDefaultStore request"},"api.response.setCustomerDefaultStore.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: setCustomerDefaultStore response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/setCustomerDefaultStore":{"post":{"tags":["Exported Services"],"summary":"This service will create/update preferred store(default facility) of a customer","description":"This service will create/update preferred store(default facility) of a customer","operationId":"setCustomerDefaultStore","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service setCustomerDefaultStore","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.setCustomerDefaultStore"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.setCustomerDefaultStore.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Set/update Reason Id on Return Item

> Set/update Reason Id on Return Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.setReasonIdOnReturnItem":{"required":["returnReasonId","shopifyOrderId","shopifyOrderLineItemId","shopifyReturnId"],"type":"object","properties":{"reason":{"type":"string"},"returnReasonId":{"type":"string"},"shopifyReturnId":{"type":"string"},"shopifyOrderLineItemId":{"type":"string"},"shopifyOrderId":{"type":"string"}},"description":"In Schema for service: setReasonIdOnReturnItem request"},"api.response.setReasonIdOnReturnItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: setReasonIdOnReturnItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/setReasonIdOnReturnItem":{"post":{"tags":["Exported Services"],"summary":"Set/update Reason Id on Return Item","description":"Set/update Reason Id on Return Item","operationId":"setReasonIdOnReturnItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service setReasonIdOnReturnItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.setReasonIdOnReturnItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.setReasonIdOnReturnItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Sets a single user preference.

> Sets a single user preference.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.setUserPreference":{"required":["userPrefTypeId","userPrefValue"],"type":"object","properties":{"userPrefGroupTypeId":{"type":"string"},"userPrefValue":{"type":"string"},"userPrefTypeId":{"type":"string"},"userPrefLoginId":{"type":"string"}},"description":"In Schema for service: setUserPreference request"},"api.response.setUserPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: setUserPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/setUserPreference":{"post":{"tags":["Exported Services"],"summary":"Sets a single user preference.","description":"Sets a single user preference.","operationId":"setUserPreference","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service setUserPreference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.setUserPreference"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.setUserPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Shop name eg. myshop is shop name for <https://myshop.myshopify.com&#x20>;

> Shop name eg. myshop is shop name for <https://myshop.myshopify.com&#x20>;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.setupShopifyShop":{"required":["accessToken","clientId","shop","shopId","shopifyConfigId","shopifyConfigName"],"type":"object","properties":{"accessScopeEnumId":{"type":"string"},"shopifyConfigId":{"type":"string"},"clientId":{"type":"string"},"shop":{"type":"string"},"processRefund":{"type":"string"},"shopifyConfigName":{"type":"string"},"shopId":{"type":"string"},"productStoreId":{"type":"string"},"oldSharedSecret":{"type":"string"},"accessToken":{"type":"string"},"sharedSecret":{"type":"string"},"webSiteId":{"type":"string"}},"description":"In Schema for service: setupShopifyShop request"},"api.response.setupShopifyShop.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shopifyConfigId":{"type":"string"},"shopId":{"type":"string"}}}},"description":"Out Schema for service: setupShopifyShop response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/setupShopifyShop":{"post":{"tags":["Exported Services"],"summary":"Shop name eg. myshop is shop name for https://myshop.myshopify.com ","description":"Shop name eg. myshop is shop name for https://myshop.myshopify.com ","operationId":"setupShopifyShop","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service setupShopifyShop","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.setupShopifyShop"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.setupShopifyShop.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create association of store with a calendar

> Create association of store with a calendar

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.storeCalendarAssocDataSetup":{"type":"object","properties":{"calendarId":{"type":"string"},"thruDateStr":{"type":"string"},"fromDateStr":{"type":"string"},"storeId":{"type":"string"},"calendarTypeId":{"type":"string"}},"description":"In Schema for service: storeCalendarAssocDataSetup request"},"api.response.storeCalendarAssocDataSetup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: storeCalendarAssocDataSetup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/storeCalendarAssocDataSetup":{"post":{"tags":["Exported Services"],"summary":"Create association of store with a calendar","description":"Create association of store with a calendar","operationId":"storeCalendarAssocDataSetup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service storeCalendarAssocDataSetup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.storeCalendarAssocDataSetup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.storeCalendarAssocDataSetup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Store firebase client registration token

> Store firebase client registration token

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.storeClientRegistrationToken":{"required":["applicationId","deviceId","registrationToken"],"type":"object","properties":{"registrationToken":{"type":"string"},"applicationId":{"type":"string"},"deviceId":{"type":"string"}},"description":"In Schema for service: storeClientRegistrationToken request"},"api.response.storeClientRegistrationToken.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: storeClientRegistrationToken response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/storeClientRegistrationToken":{"post":{"tags":["Exported Services"],"summary":"Store firebase client registration token","description":"Store firebase client registration token","operationId":"storeClientRegistrationToken","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service storeClientRegistrationToken","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.storeClientRegistrationToken"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.storeClientRegistrationToken.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Run Entity Sync

> Run Entity Sync

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.storeEntitySyncData":{"required":["entitySyncId","keysToRemove","valuesToCreate","valuesToStore"],"type":"object","properties":{"valuesToStore":{"type":"array","items":{"type":"string"}},"delegatorName":{"type":"string"},"entitySyncId":{"type":"string"},"keysToRemove":{"type":"array","items":{"type":"string"}},"valuesToCreate":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: storeEntitySyncData request"},"api.response.storeEntitySyncData.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"toStoreUpdated":{"type":"integer","format":"int32"},"toCreateInserted":{"type":"integer","format":"int32"},"toCreateUpdated":{"type":"integer","format":"int32"},"toCreateNotUpdated":{"type":"integer","format":"int32"},"toRemoveAlreadyDeleted":{"type":"integer","format":"int32"},"toStoreNotUpdated":{"type":"integer","format":"int32"},"toRemoveDeleted":{"type":"integer","format":"int32"},"toStoreInserted":{"type":"integer","format":"int32"}}}},"description":"Out Schema for service: storeEntitySyncData response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/storeEntitySyncData":{"post":{"tags":["Exported Services"],"summary":"Run Entity Sync","description":"Run Entity Sync","operationId":"storeEntitySyncData","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service storeEntitySyncData","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.storeEntitySyncData"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.storeEntitySyncData.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe order cancel webhook on Shopify

> Subscribe order cancel webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeCancelOrderShopifyWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"endpoint":{"type":"string"},"shopifyConfigId":{"type":"string"},"topic":{"type":"string"}},"description":"In Schema for service: subscribeCancelOrderShopifyWebhook request"},"api.response.subscribeCancelOrderShopifyWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"webhook":{"type":"string"}}}},"description":"Out Schema for service: subscribeCancelOrderShopifyWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeCancelOrderShopifyWebhook":{"post":{"tags":["Exported Services"],"summary":"Subscribe order cancel webhook on Shopify","description":"Subscribe order cancel webhook on Shopify","operationId":"subscribeCancelOrderShopifyWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeCancelOrderShopifyWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeCancelOrderShopifyWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeCancelOrderShopifyWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe order create webhook on Shopify

> Subscribe order create webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeCreateOrderShopifyWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"endpoint":{"type":"string"},"shopifyConfigId":{"type":"string"},"topic":{"type":"string"}},"description":"In Schema for service: subscribeCreateOrderShopifyWebhook request"},"api.response.subscribeCreateOrderShopifyWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"webhook":{"type":"string"}}}},"description":"Out Schema for service: subscribeCreateOrderShopifyWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeCreateOrderShopifyWebhook":{"post":{"tags":["Exported Services"],"summary":"Subscribe order create webhook on Shopify","description":"Subscribe order create webhook on Shopify","operationId":"subscribeCreateOrderShopifyWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeCreateOrderShopifyWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeCreateOrderShopifyWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeCreateOrderShopifyWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe file status update webhook on Shopify

> Subscribe file status update webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeFileStatusUpdateWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"}},"description":"In Schema for service: subscribeFileStatusUpdateWebhook request"},"api.response.subscribeFileStatusUpdateWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: subscribeFileStatusUpdateWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeFileStatusUpdateWebhook":{"post":{"tags":["Exported Services"],"summary":"Subscribe file status update webhook on Shopify","description":"Subscribe file status update webhook on Shopify","operationId":"subscribeFileStatusUpdateWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeFileStatusUpdateWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeFileStatusUpdateWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeFileStatusUpdateWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe order paid webhook on Shopify

> Subscribe order paid webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeOrderPaidWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"}},"description":"In Schema for service: subscribeOrderPaidWebhook request"},"api.response.subscribeOrderPaidWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: subscribeOrderPaidWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeOrderPaidWebhook":{"post":{"tags":["Exported Services"],"summary":"Subscribe order paid webhook on Shopify","description":"Subscribe order paid webhook on Shopify","operationId":"subscribeOrderPaidWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeOrderPaidWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeOrderPaidWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeOrderPaidWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe order return webhook on Shopify

> Subscribe order return webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeReturnOrderShopifyWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"endpoint":{"type":"string"},"shopifyConfigId":{"type":"string"},"topic":{"type":"string"}},"description":"In Schema for service: subscribeReturnOrderShopifyWebhook request"},"api.response.subscribeReturnOrderShopifyWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"webhook":{"type":"string"}}}},"description":"Out Schema for service: subscribeReturnOrderShopifyWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeReturnOrderShopifyWebhook":{"post":{"tags":["Exported Services"],"summary":"Subscribe order return webhook on Shopify","description":"Subscribe order return webhook on Shopify","operationId":"subscribeReturnOrderShopifyWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeReturnOrderShopifyWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeReturnOrderShopifyWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeReturnOrderShopifyWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe webhook on Shopify

> Subscribe webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeShopifyWebhook":{"required":["shopifyConfigId","topic"],"type":"object","properties":{"endpoint":{"type":"string"},"shopifyConfigId":{"type":"string"},"format":{"type":"string"},"topic":{"type":"string"}},"description":"In Schema for service: subscribeShopifyWebhook request"},"api.response.subscribeShopifyWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"webhook":{"type":"string"}}}},"description":"Out Schema for service: subscribeShopifyWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeShopifyWebhook":{"post":{"tags":["Exported Services"],"summary":"Subscribe webhook on Shopify","description":"Subscribe webhook on Shopify","operationId":"subscribeShopifyWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeShopifyWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeShopifyWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeShopifyWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Subscribe Topic

> Subscribe Topic

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.subscribeTopic":{"required":["applicationId","topicName"],"type":"object","properties":{"topicName":{"type":"string"},"applicationId":{"type":"string"}},"description":"In Schema for service: subscribeTopic request"},"api.response.subscribeTopic.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: subscribeTopic response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/subscribeTopic":{"post":{"tags":["Exported Services"],"summary":"Subscribe Topic","description":"Subscribe Topic","operationId":"subscribeTopic","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service subscribeTopic","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.subscribeTopic"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.subscribeTopic.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Test service

> Test service

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.testCommit":{"type":"object","properties":{"message":{"type":"string"}},"description":"In Schema for service: testCommit request"},"api.response.testCommit.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"resp":{"type":"string"}}}},"description":"Out Schema for service: testCommit response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/testCommit":{"post":{"tags":["Exported Services"],"summary":"Test service","description":"Test service","operationId":"testCommit","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service testCommit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.testCommit"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.testCommit.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/testError

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.testError":{"type":"object","description":"In Schema for service: testError request"},"api.response.testError.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: testError response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/testError":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"testError","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service testError","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.testError"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.testError.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Test service

> Test service

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.testRollback":{"type":"object","properties":{"message":{"type":"string"}},"description":"In Schema for service: testRollback request"},"api.response.testRollback.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"resp":{"type":"string"}}}},"description":"Out Schema for service: testRollback response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/testRollback":{"post":{"tags":["Exported Services"],"summary":"Test service","description":"Test service","operationId":"testRollback","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service testRollback","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.testRollback"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.testRollback.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Test service

> Test service

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.testScv":{"type":"object","properties":{"defaultValue":{"type":"number"},"message":{"type":"string"}},"description":"In Schema for service: testScv request"},"api.response.testScv.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"resp":{"type":"string"}}}},"description":"Out Schema for service: testScv response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/testScv":{"post":{"tags":["Exported Services"],"summary":"Test service","description":"Test service","operationId":"testScv","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service testScv","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.testScv"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.testScv.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Send a post request to run a DAG in airflow

> Send a post request to run a DAG in airflow

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.triggerDag":{"required":["endpoint"],"type":"object","properties":{"endpoint":{"type":"string"}},"description":"In Schema for service: triggerDag request"},"api.response.triggerDag.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: triggerDag response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/triggerDag":{"post":{"tags":["Exported Services"],"summary":"Send a post request to run a DAG in airflow","description":"Send a post request to run a DAG in airflow","operationId":"triggerDag","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service triggerDag","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.triggerDag"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.triggerDag.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## This service unlinks return from the order, It won't delete the data from the entities.

> This service unlinks return from the order, It won't delete the data from the entities.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.unlinkReturnFromOrder":{"required":["returnId"],"type":"object","properties":{"returnId":{"type":"string"}},"description":"In Schema for service: unlinkReturnFromOrder request"},"api.response.unlinkReturnFromOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: unlinkReturnFromOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/unlinkReturnFromOrder":{"post":{"tags":["Exported Services"],"summary":"This service unlinks return from the order, It won't delete the data from the entities.","description":"This service unlinks return from the order, It won't delete the data from the entities.","operationId":"unlinkReturnFromOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service unlinkReturnFromOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.unlinkReturnFromOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unlinkReturnFromOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Unlock order item in a bin

> Unlock order item in a bin

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.unlockStoreFulfillmentOrder":{"required":["orderId","picklistBinId"],"type":"object","properties":{"orderId":{"type":"string"},"picklistBinId":{"type":"string"}},"description":"In Schema for service: unlockStoreFulfillmentOrder request"},"api.response.unlockStoreFulfillmentOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: unlockStoreFulfillmentOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/unlockStoreFulfillmentOrder":{"post":{"tags":["Exported Services"],"summary":"Unlock order item in a bin","description":"Unlock order item in a bin","operationId":"unlockStoreFulfillmentOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service unlockStoreFulfillmentOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.unlockStoreFulfillmentOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unlockStoreFulfillmentOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## unsubscribe webhook on Shopify

> unsubscribe webhook on Shopify

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.unsubscribeShopifyWebhook":{"required":["shopifyConfigId","topic"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"topic":{"type":"string"}},"description":"In Schema for service: unsubscribeShopifyWebhook request"},"api.response.unsubscribeShopifyWebhook.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: unsubscribeShopifyWebhook response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/unsubscribeShopifyWebhook":{"post":{"tags":["Exported Services"],"summary":"unsubscribe webhook on Shopify","description":"unsubscribe webhook on Shopify","operationId":"unsubscribeShopifyWebhook","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service unsubscribeShopifyWebhook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.unsubscribeShopifyWebhook"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unsubscribeShopifyWebhook.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Unsubscribe Topic

> Unsubscribe Topic

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.unsubscribeTopic":{"required":["applicationId","topicName"],"type":"object","properties":{"topicName":{"type":"string"},"applicationId":{"type":"string"}},"description":"In Schema for service: unsubscribeTopic request"},"api.response.unsubscribeTopic.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: unsubscribeTopic response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/unsubscribeTopic":{"post":{"tags":["Exported Services"],"summary":"Unsubscribe Topic","description":"Unsubscribe Topic","operationId":"unsubscribeTopic","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service unsubscribeTopic","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.unsubscribeTopic"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unsubscribeTopic.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Updating all the orderItems, if the orderItemSeqId not provided in context.

> Updating all the orderItems, if the orderItemSeqId not provided in context.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateAllOrderItems":{"required":["orderId"],"type":"object","properties":{"requestedDeliveryTime":{"type":"string"},"orderId":{"type":"string"},"isNewProduct":{"type":"string"},"returnTillDate":{"type":"string","format":"date"},"deploymentId":{"type":"string"},"cancelBackOrderDate":{"type":"string","format":"date"},"itemDescription":{"type":"string"},"selectedAmount":{"type":"number"},"unitPrice":{"type":"number"},"orderItemSeqId":{"type":"string"},"productId":{"type":"string"},"unitRecurringPrice":{"type":"number"},"autoCancelDate":{"type":"string","format":"date"},"isItemGroupPrimary":{"type":"string"},"productFeatureId":{"type":"string"},"overrideGlAccountId":{"type":"string"},"budgetId":{"type":"string"},"taxCode":{"type":"string"},"supplierProductId":{"type":"string"},"estimatedDeliveryDate":{"type":"string","format":"date"},"shipGroupSeqId":{"type":"string"},"quoteId":{"type":"string"},"requestedShipMethTypeId":{"type":"string"},"availableToPromise":{"type":"number"},"statusId":{"type":"string"},"syncStatusId":{"type":"string"},"requestedDeliveryDate":{"type":"string"},"estimatedShipDate":{"type":"string","format":"date"},"shoppingListItemSeqId":{"type":"string"},"subscriptionId":{"type":"string"},"salesOpportunityId":{"type":"string"},"dontCancelSetUserLogin":{"type":"string"},"promisedDatetime":{"type":"string","format":"date"},"isModifiedPrice":{"type":"string"},"isPromo":{"type":"string"},"shipBeforeDate":{"type":"string","format":"date"},"productCategoryId":{"type":"string"},"unitListPrice":{"type":"number"},"shoppingListId":{"type":"string"},"unitAverageCost":{"type":"number"},"orderItemTypeId":{"type":"string"},"dontCancelSetDate":{"type":"string","format":"date"},"comments":{"type":"string"},"quantity":{"type":"number"},"recurringFreqUomId":{"type":"string"},"orderItemGroupSeqId":{"type":"string"},"quoteItemSeqId":{"type":"string"},"fromInventoryItemId":{"type":"string"},"externalId":{"type":"string"},"budgetItemSeqId":{"type":"string"},"correspondingPoId":{"type":"string"},"cancelQuantity":{"type":"number"},"shipAfterDate":{"type":"string","format":"date"},"deliveryWindow":{"type":"number"},"shipmentId":{"type":"string"},"changeByUserLoginId":{"type":"string"},"prodCatalogId":{"type":"string"}},"description":"In Schema for service: updateAllOrderItems request"},"api.response.updateAllOrderItems.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateAllOrderItems response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateAllOrderItems":{"post":{"tags":["Exported Services"],"summary":"Updating all the orderItems, if the orderItemSeqId not provided in context.","description":"Updating all the orderItems, if the orderItemSeqId not provided in context.","operationId":"updateAllOrderItems","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateAllOrderItems","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateAllOrderItems"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateAllOrderItems.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a CarrierGeoMapping record

> Update a CarrierGeoMapping record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateCarrierGeoMapping":{"required":["geoMapId"],"type":"object","properties":{"geoName":{"type":"string"},"geoTypeId":{"type":"string"},"carrierPartyId":{"type":"string"},"geoMapId":{"type":"string"},"geoId":{"type":"string"},"carrierGeoValue":{"type":"string"}},"description":"In Schema for service: updateCarrierGeoMapping request"},"api.response.updateCarrierGeoMapping.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateCarrierGeoMapping response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateCarrierGeoMapping":{"post":{"tags":["Exported Services"],"summary":"Update a CarrierGeoMapping record","description":"Update a CarrierGeoMapping record","operationId":"updateCarrierGeoMapping","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateCarrierGeoMapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateCarrierGeoMapping"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateCarrierGeoMapping.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Updates A CarrierShipmentMethod

> Updates A CarrierShipmentMethod

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateCarrierShipmentMethod":{"required":["partyId","roleTypeId","shipmentMethodTypeId"],"type":"object","properties":{"sequenceNumber":{"type":"integer","format":"int32"},"roleTypeId":{"type":"string"},"deliveryDays":{"type":"integer","format":"int32"},"partyId":{"type":"string"},"carrierServiceCode":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: updateCarrierShipmentMethod request"},"api.response.updateCarrierShipmentMethod.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateCarrierShipmentMethod response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateCarrierShipmentMethod":{"post":{"tags":["Exported Services"],"summary":"Updates A CarrierShipmentMethod","description":"Updates A CarrierShipmentMethod","operationId":"updateCarrierShipmentMethod","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateCarrierShipmentMethod","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateCarrierShipmentMethod"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateCarrierShipmentMethod.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## update a DataManagerConfig

> update a DataManagerConfig

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateDataManagerConfig":{"type":"object","properties":{"importPath":{"type":"string"},"exportServiceScreenLocation":{"type":"string"},"exportServiceScreenName":{"type":"string"},"importServiceName":{"type":"string"},"fileNamePattern":{"type":"string"},"multiThreading":{"type":"string"},"description":{"type":"string"},"priority":{"type":"integer","format":"int32"},"exportPath":{"type":"string"},"exportContentId":{"type":"string"},"notifyOnFailure":{"type":"string"},"delimiter":{"type":"string"},"configId":{"type":"string"},"exportServiceName":{"type":"string"},"scriptTitle":{"type":"string"},"executionModeId":{"type":"string"}},"description":"In Schema for service: updateDataManagerConfig request"},"api.response.updateDataManagerConfig.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"configId":{"type":"string"}}}},"description":"Out Schema for service: updateDataManagerConfig response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateDataManagerConfig":{"post":{"tags":["Exported Services"],"summary":"update a DataManagerConfig","description":"update a DataManagerConfig","operationId":"updateDataManagerConfig","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateDataManagerConfig","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateDataManagerConfig"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateDataManagerConfig.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a DataManagerMapping

> Update a DataManagerMapping

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateDataManagerMapping":{"required":["mappingPrefId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"mappingPrefName":{"type":"string"},"mappingPrefTypeEnumId":{"type":"string"},"mappingPrefId":{"type":"string"},"mappingPrefValue":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateDataManagerMapping request"},"api.response.updateDataManagerMapping.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateDataManagerMapping response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateDataManagerMapping":{"post":{"tags":["Exported Services"],"summary":"Update a DataManagerMapping","description":"Update a DataManagerMapping","operationId":"updateDataManagerMapping","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateDataManagerMapping","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateDataManagerMapping"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateDataManagerMapping.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Enumeration

> Update a Enumeration

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateEnumeration":{"required":["description","enumId","enumTypeId"],"type":"object","properties":{"enumTypeId":{"type":"string"},"enumId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"enumCode":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"},"description":{"type":"string"},"enumName":{"type":"string"},"sequenceId":{"type":"string"}},"description":"In Schema for service: updateEnumeration request"},"api.response.updateEnumeration.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateEnumeration response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateEnumeration":{"post":{"tags":["Exported Services"],"summary":"Update a Enumeration","description":"Update a Enumeration","operationId":"updateEnumeration","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateEnumeration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateEnumeration"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateEnumeration.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update enumeration group member

> Update enumeration group member

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateEnumerationGroupMember":{"required":["enumerationGroupId","enumerationId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"enumerationId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"enumerationGroupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateEnumerationGroupMember request"},"api.response.updateEnumerationGroupMember.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateEnumerationGroupMember response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateEnumerationGroupMember":{"post":{"tags":["Exported Services"],"summary":"Update enumeration group member","description":"Update enumeration group member","operationId":"updateEnumerationGroupMember","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateEnumerationGroupMember","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateEnumerationGroupMember"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateEnumerationGroupMember.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Bulk Update Facility -> Group Member

> Bulk Update Facility -> Group Member

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilitiesToGroup":{"required":["payload"],"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: updateFacilitiesToGroup request"},"api.response.updateFacilitiesToGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateFacilitiesToGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilitiesToGroup":{"post":{"tags":["Exported Services"],"summary":"Bulk Update Facility -> Group Member","description":"Bulk Update Facility -> Group Member","operationId":"updateFacilitiesToGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilitiesToGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilitiesToGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilitiesToGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Facility

> Update a Facility

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacility":{"required":["facilityId"],"type":"object","properties":{"facilityId":{"type":"string"},"defaultInventoryItemTypeId":{"type":"string"},"parentFacilityId":{"type":"string"},"postalCode":{"type":"string"},"externalId":{"type":"string"},"description":{"type":"string"},"defaultWeightUomId":{"type":"string"},"primaryFacilityGroupId":{"type":"string"},"openedDate":{"type":"string","format":"date"},"ownerPartyId":{"type":"string"},"facilityTimeZone":{"type":"string"},"facilitySize":{"type":"number"},"closedDate":{"type":"string","format":"date"},"facilitySizeUomId":{"type":"string"},"maximumOrderLimit":{"type":"integer","format":"int32"},"closeTime":{"type":"string"},"defaultDaysToShip":{"type":"integer","format":"int32"},"facilityTypeId":{"type":"string"},"defaultDimensionUomId":{"type":"string"},"productStoreId":{"type":"string"},"facilityName":{"type":"string"},"openTime":{"type":"string"},"geoPointId":{"type":"string"},"oldSquareFootage":{"type":"integer","format":"int32"}},"description":"In Schema for service: updateFacility request"},"api.response.updateFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacility":{"post":{"tags":["Exported Services"],"summary":"Update a Facility","description":"Update a Facility","operationId":"updateFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a FacilityContactMech

> Update a FacilityContactMech

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityContactMech":{"required":["contactMechId","contactMechTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"extension":{"type":"string"},"infoString":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"newContactMechId":{"type":"string"},"contactMechTypeId":{"type":"string"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateFacilityContactMech request"},"api.response.updateFacilityContactMech.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: updateFacilityContactMech response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityContactMech":{"post":{"tags":["Exported Services"],"summary":"Update a FacilityContactMech","description":"Update a FacilityContactMech","operationId":"updateFacilityContactMech","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityContactMech","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityContactMech"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityContactMech.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update an Email Address

> Update an Email Address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityEmailAddress":{"required":["contactMechId","emailAddress"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"emailAddress":{"type":"string"},"extension":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateFacilityEmailAddress request"},"api.response.updateFacilityEmailAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: updateFacilityEmailAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityEmailAddress":{"post":{"tags":["Exported Services"],"summary":"Update an Email Address","description":"Update an Email Address","operationId":"updateFacilityEmailAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityEmailAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityEmailAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityEmailAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Facility Group

> Update a Facility Group

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityGroup":{"required":["facilityGroupId"],"type":"object","properties":{"primaryParentGroupId":{"type":"string"},"facilityGroupTypeId":{"type":"string"},"facilityGroupId":{"type":"string"},"description":{"type":"string"},"facilityGroupName":{"type":"string"}},"description":"In Schema for service: updateFacilityGroup request"},"api.response.updateFacilityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateFacilityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityGroup":{"post":{"tags":["Exported Services"],"summary":"Update a Facility Group","description":"Update a Facility Group","operationId":"updateFacilityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a FacilityIdentification

> Update a FacilityIdentification

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityIdentification":{"required":["facilityId","facilityIdenTypeId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"idValue":{"type":"string"},"facilityIdenTypeId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateFacilityIdentification request"},"api.response.updateFacilityIdentification.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateFacilityIdentification response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityIdentification":{"post":{"tags":["Exported Services"],"summary":"Update a FacilityIdentification","description":"Update a FacilityIdentification","operationId":"updateFacilityIdentification","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityIdentification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityIdentification"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityIdentification.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Facility Location

> Update a Facility Location

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityLocation":{"required":["facilityId","locationSeqId"],"type":"object","properties":{"nextCountDate":{"type":"string"},"lastCountDate":{"type":"string"},"areaId":{"type":"string"},"facilityId":{"type":"string"},"positionId":{"type":"string"},"isLocked":{"type":"string"},"levelId":{"type":"string"},"sectionId":{"type":"string"},"geoPointId":{"type":"string"},"locationTypeEnumId":{"type":"string"},"aisleId":{"type":"string"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: updateFacilityLocation request"},"api.response.updateFacilityLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateFacilityLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityLocation":{"post":{"tags":["Exported Services"],"summary":"Update a Facility Location","description":"Update a Facility Location","operationId":"updateFacilityLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Postal Address

> Update a Postal Address

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityPostalAddress":{"required":["contactMechId"],"type":"object","properties":{"houseNumberExt":{"type":"string"},"extension":{"type":"string"},"city":{"type":"string"},"latitude":{"type":"string"},"postalCodeGeoId":{"type":"string"},"postalCode":{"type":"string"},"houseNumber":{"type":"integer","format":"int32"},"postalCodeExt":{"type":"string"},"contactMechId":{"type":"string"},"attnName":{"type":"string"},"countyGeoId":{"type":"string"},"toName":{"type":"string"},"cityGeoId":{"type":"string"},"longitude":{"type":"string"},"countryGeoId":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"address2":{"type":"string"},"address1":{"type":"string"},"encodedAddressKey":{"type":"string"},"thruDate":{"type":"string","format":"date"},"fromDate":{"type":"string","format":"date"},"directions":{"type":"string"},"municipalityGeoId":{"type":"string"},"stateProvinceGeoId":{"type":"string"},"geoPointId":{"type":"string"}},"description":"In Schema for service: updateFacilityPostalAddress request"},"api.response.updateFacilityPostalAddress.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: updateFacilityPostalAddress response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityPostalAddress":{"post":{"tags":["Exported Services"],"summary":"Update a Postal Address","description":"Update a Postal Address","operationId":"updateFacilityPostalAddress","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityPostalAddress","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityPostalAddress"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityPostalAddress.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Telecommunications Number

> Update a Telecommunications Number

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityTelecomNumber":{"required":["contactMechId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"askForName":{"type":"string"},"areaCode":{"type":"string"},"extension":{"type":"string"},"comments":{"type":"string"},"facilityId":{"type":"string"},"countryCode":{"type":"string"},"contactNumber":{"type":"string"},"contactMechId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateFacilityTelecomNumber request"},"api.response.updateFacilityTelecomNumber.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"contactMechId":{"type":"string"}}}},"description":"Out Schema for service: updateFacilityTelecomNumber response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityTelecomNumber":{"post":{"tags":["Exported Services"],"summary":"Update a Telecommunications Number","description":"Update a Telecommunications Number","operationId":"updateFacilityTelecomNumber","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityTelecomNumber","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityTelecomNumber"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityTelecomNumber.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Facility -> Group Member

> Update Facility -> Group Member

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateFacilityToGroup":{"required":["facilityGroupId","facilityId","fromDate"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"facilityGroupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateFacilityToGroup request"},"api.response.updateFacilityToGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateFacilityToGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateFacilityToGroup":{"post":{"tags":["Exported Services"],"summary":"Update Facility -> Group Member","description":"Update Facility -> Group Member","operationId":"updateFacilityToGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateFacilityToGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateFacilityToGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateFacilityToGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Service to sync inventory from file provided by external systems

> Service to sync inventory from file provided by external systems

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateInventoryByIdentification":{"required":["availableDelta"],"type":"object","properties":{"varianceReasonId":{"type":"string"},"comments":{"type":"string"},"idType":{"type":"string"},"facilityId":{"type":"string"},"idValue":{"type":"string"},"externalFacilityId":{"type":"string"},"locationSeqId":{"type":"string"},"availableDelta":{"type":"string"}},"description":"In Schema for service: updateInventoryByIdentification request"},"api.response.updateInventoryByIdentification.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateInventoryByIdentification response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateInventoryByIdentification":{"post":{"tags":["Exported Services"],"summary":"Service to sync inventory from file provided by external systems","description":"Service to sync inventory from file provided by external systems","operationId":"updateInventoryByIdentification","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateInventoryByIdentification","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateInventoryByIdentification"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateInventoryByIdentification.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update JobSandbox record

> Update JobSandbox record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateJobSandbox":{"required":["jobId"],"type":"object","properties":{"recurrenceInfoId":{"type":"string"},"cancelDateTime":{"type":"string","format":"date"},"tempExprId":{"type":"string"},"authUserLoginId":{"type":"string"},"currentRetryCount":{"type":"integer","format":"int32"},"runTimeEpoch":{"type":"integer","format":"int32"},"lastModifiedByUserLogin":{"type":"string"},"loaderName":{"type":"string"},"shopId":{"type":"string"},"productStoreId":{"type":"string"},"runTime":{"type":"string","format":"date"},"createdByUserLogin":{"type":"string"},"jobName":{"type":"string"},"runThread":{"type":"string"},"runByInstanceId":{"type":"string"},"maxRecurrenceCount":{"type":"integer","format":"int32"},"currentRecurrenceCount":{"type":"integer","format":"int32"},"serviceName":{"type":"string"},"priority":{"type":"integer","format":"int32"},"runtimeDataId":{"type":"string"},"finishDateTime":{"type":"string","format":"date"},"runAsUser":{"type":"string"},"maxRetry":{"type":"integer","format":"int32"},"jobId":{"type":"string"},"createdDate":{"type":"string","format":"date"},"startDateTime":{"type":"string","format":"date"},"statusId":{"type":"string"},"previousJobId":{"type":"string"},"parentJobId":{"type":"string"},"jobResult":{"type":"string"},"poolId":{"type":"string"},"systemJobEnumId":{"type":"string"},"recurrenceTimeZone":{"type":"string"},"instanceOfProductId":{"type":"string"}},"description":"In Schema for service: updateJobSandbox request"},"api.response.updateJobSandbox.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateJobSandbox response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateJobSandbox":{"post":{"tags":["Exported Services"],"summary":"Update JobSandbox record","description":"Update JobSandbox record","operationId":"updateJobSandbox","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateJobSandbox","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateJobSandbox"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateJobSandbox.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Atomic updates OISGIR Solr document for rejected item.

> Atomic updates OISGIR Solr document for rejected item.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOISGIRIFulfillmentStatus":{"type":"object","properties":{"inventoryItemId":{"type":"string"},"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"shipGroupSeqId":{"type":"string"}},"description":"In Schema for service: updateOISGIRIFulfillmentStatus request"},"api.response.updateOISGIRIFulfillmentStatus.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOISGIRIFulfillmentStatus response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOISGIRIFulfillmentStatus":{"post":{"tags":["Exported Services"],"summary":"Atomic updates OISGIR Solr document for rejected item.","description":"Atomic updates OISGIR Solr document for rejected item.","operationId":"updateOISGIRIFulfillmentStatus","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOISGIRIFulfillmentStatus","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOISGIRIFulfillmentStatus"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOISGIRIFulfillmentStatus.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

\
&#x20;           This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity\
&#x20;      &#x20;
------------------

> \
> &#x20;           This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity\
> &#x20;      &#x20;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderAddressAndAppendAttributes":{"type":"object","properties":{"lookupField":{"type":"string"},"geoTypeId":{"type":"string"},"orderId":{"type":"string"},"attributesToAppend":{"type":"object"},"fieldsToUpdate":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: updateOrderAddressAndAppendAttributes request"},"api.response.updateOrderAddressAndAppendAttributes.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"orderId":{"type":"string"}}}},"description":"Out Schema for service: updateOrderAddressAndAppendAttributes response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderAddressAndAppendAttributes":{"post":{"tags":["Exported Services"],"summary":"\n            This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity\n        ","description":"\n            This service will update the Shipping Address of the order based on city/state (Any field present in PostalAddress) with mapping from CarrierGeoMapping entity\n        ","operationId":"updateOrderAddressAndAppendAttributes","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderAddressAndAppendAttributes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderAddressAndAppendAttributes"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderAddressAndAppendAttributes.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update an OrderAttribute record

> Update an OrderAttribute record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderAttribute":{"required":["attrName","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"attrDescription":{"type":"string"},"attrValue":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: updateOrderAttribute request"},"api.response.updateOrderAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOrderAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderAttribute":{"post":{"tags":["Exported Services"],"summary":"Update an OrderAttribute record","description":"Update an OrderAttribute record","operationId":"updateOrderAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Order Item

> Update Order Item

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderItem":{"required":["orderId","orderItemSeqId"],"type":"object","properties":{"requestedDeliveryTime":{"type":"string"},"orderId":{"type":"string"},"isNewProduct":{"type":"string"},"returnTillDate":{"type":"string","format":"date"},"deploymentId":{"type":"string"},"cancelBackOrderDate":{"type":"string","format":"date"},"itemDescription":{"type":"string"},"selectedAmount":{"type":"number"},"unitPrice":{"type":"number"},"orderItemSeqId":{"type":"string"},"productId":{"type":"string"},"unitRecurringPrice":{"type":"number"},"autoCancelDate":{"type":"string","format":"date"},"isItemGroupPrimary":{"type":"string"},"productFeatureId":{"type":"string"},"overrideGlAccountId":{"type":"string"},"budgetId":{"type":"string"},"taxCode":{"type":"string"},"supplierProductId":{"type":"string"},"estimatedDeliveryDate":{"type":"string","format":"date"},"shipGroupSeqId":{"type":"string"},"quoteId":{"type":"string"},"requestedShipMethTypeId":{"type":"string"},"availableToPromise":{"type":"number"},"statusId":{"type":"string"},"syncStatusId":{"type":"string"},"requestedDeliveryDate":{"type":"string"},"estimatedShipDate":{"type":"string","format":"date"},"shoppingListItemSeqId":{"type":"string"},"subscriptionId":{"type":"string"},"salesOpportunityId":{"type":"string"},"dontCancelSetUserLogin":{"type":"string"},"promisedDatetime":{"type":"string","format":"date"},"isModifiedPrice":{"type":"string"},"isPromo":{"type":"string"},"shipBeforeDate":{"type":"string","format":"date"},"productCategoryId":{"type":"string"},"unitListPrice":{"type":"number"},"shoppingListId":{"type":"string"},"unitAverageCost":{"type":"number"},"orderItemTypeId":{"type":"string"},"dontCancelSetDate":{"type":"string","format":"date"},"comments":{"type":"string"},"quantity":{"type":"number"},"recurringFreqUomId":{"type":"string"},"orderItemGroupSeqId":{"type":"string"},"quoteItemSeqId":{"type":"string"},"fromInventoryItemId":{"type":"string"},"externalId":{"type":"string"},"budgetItemSeqId":{"type":"string"},"correspondingPoId":{"type":"string"},"cancelQuantity":{"type":"number"},"shipAfterDate":{"type":"string","format":"date"},"deliveryWindow":{"type":"number"},"shipmentId":{"type":"string"},"changeByUserLoginId":{"type":"string"},"prodCatalogId":{"type":"string"}},"description":"In Schema for service: updateOrderItem request"},"api.response.updateOrderItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOrderItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderItem":{"post":{"tags":["Exported Services"],"summary":"Update Order Item","description":"Update Order Item","operationId":"updateOrderItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Order Item Attribute

> Update Order Item Attribute

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderItemAttribute":{"required":["attrName","orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"},"attrDescription":{"type":"string"},"attrValue":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: updateOrderItemAttribute request"},"api.response.updateOrderItemAttribute.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOrderItemAttribute response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderItemAttribute":{"post":{"tags":["Exported Services"],"summary":"Update Order Item Attribute","description":"Update Order Item Attribute","operationId":"updateOrderItemAttribute","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderItemAttribute","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderItemAttribute"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderItemAttribute.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Sync Order Items (Shopify --> HC)

> Sync Order Items (Shopify --> HC)

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderItemFromShopify":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"payload":{"type":"object"}},"description":"In Schema for service: updateOrderItemFromShopify request"},"api.response.updateOrderItemFromShopify.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOrderItemFromShopify response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderItemFromShopify":{"post":{"tags":["Exported Services"],"summary":"Sync Order Items (Shopify --> HC)","description":"Sync Order Items (Shopify --> HC)","operationId":"updateOrderItemFromShopify","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderItemFromShopify","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderItemFromShopify"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderItemFromShopify.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Updates OrderItemShipGroup.  The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}

> Updates OrderItemShipGroup.  The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderItemShipGroup":{"required":["orderId","shipGroupSeqId"],"type":"object","properties":{"carrierService":{"type":"string"},"facilityId":{"type":"string"},"giftMessage":{"type":"string"},"orderId":{"type":"string"},"shippingInstructions":{"type":"string"},"shipByDate":{"type":"string","format":"date"},"maySplit":{"type":"string"},"estimatedDeliveryDate":{"type":"string","format":"date"},"shipGroupSeqId":{"type":"string"},"contactMechId":{"type":"string"},"vendorPartyId":{"type":"string"},"shipAfterDate":{"type":"string","format":"date"},"telecomContactMechId":{"type":"string"},"shipmentMethod":{"type":"string"},"carrierPartyId":{"type":"string"},"contactMechPurposeTypeId":{"type":"string"},"carrierRoleTypeId":{"type":"string"},"oldContactMechId":{"type":"string"},"estimatedShipDate":{"type":"string","format":"date"},"isGift":{"type":"string"},"supplierPartyId":{"type":"string"},"carrierAccountNumber":{"type":"string"},"trackingNumber":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"orderFacilityId":{"type":"string"}},"description":"In Schema for service: updateOrderItemShipGroup request"},"api.response.updateOrderItemShipGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOrderItemShipGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderItemShipGroup":{"post":{"tags":["Exported Services"],"summary":"Updates OrderItemShipGroup.  The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}","description":"Updates OrderItemShipGroup.  The shipmentMethod field is of the format ${shipmentMethodTypeId}@${carrierPartyId}","operationId":"updateOrderItemShipGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderItemShipGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderItemShipGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderItemShipGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update OrderPayemntPreference

> Update OrderPayemntPreference

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateOrderPaymentPreferenceV2":{"required":["orderPaymentPreferenceId"],"type":"object","properties":{"cardName":{"type":"string"},"orderId":{"type":"string"},"manualAuthCode":{"type":"string"},"presentmentAmount":{"type":"number"},"lastModifiedByUserLogin":{"type":"string"},"orderPaymentPreferenceId":{"type":"string"},"exchangeRate":{"type":"number"},"requestId":{"type":"string"},"presentmentCurrencyUom":{"type":"string"},"paymentMethodId":{"type":"string"},"overflowFlag":{"type":"string"},"maxAmount":{"type":"number"},"productPricePurposeId":{"type":"string"},"createdByUserLogin":{"type":"string"},"orderItemSeqId":{"type":"string"},"track2":{"type":"string"},"paymentMode":{"type":"string"},"lastModifiedDate":{"type":"string","format":"date"},"manualRefNum":{"type":"string"},"swipedFlag":{"type":"string"},"parentRefNum":{"type":"string"},"securityCode":{"type":"string"},"paymentMethodTypeId":{"type":"string"},"applicationIdentifier":{"type":"string"},"shipGroupSeqId":{"type":"string"},"processAttempt":{"type":"integer","format":"int32"},"needsNsfRetry":{"type":"string"},"finAccountId":{"type":"string"},"createdDate":{"type":"string","format":"date"},"statusId":{"type":"string"},"billingPostalCode":{"type":"string"},"presentFlag":{"type":"string"}},"description":"In Schema for service: updateOrderPaymentPreferenceV2 request"},"api.response.updateOrderPaymentPreferenceV2.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateOrderPaymentPreferenceV2 response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateOrderPaymentPreferenceV2":{"post":{"tags":["Exported Services"],"summary":"Update OrderPayemntPreference","description":"Update OrderPayemntPreference","operationId":"updateOrderPaymentPreferenceV2","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateOrderPaymentPreferenceV2","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateOrderPaymentPreferenceV2"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateOrderPaymentPreferenceV2.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a PartyGroup

> Update a PartyGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updatePartyGroup":{"type":"object","properties":{"pdfLogoImageUrl":{"type":"string"},"comments":{"type":"string"},"externalId":{"type":"string"},"description":{"type":"string"},"tickerSymbol":{"type":"string"},"logoImageUrl":{"type":"string"},"partyTypeId":{"type":"string"},"groupName":{"type":"string"},"groupNameLocal":{"type":"string"},"statusId":{"type":"string"},"numEmployees":{"type":"integer","format":"int32"},"preferredCurrencyUomId":{"type":"string"},"ranking":{"type":"integer","format":"int32"},"partyId":{"type":"string"},"annualRevenue":{"type":"number"},"officeSiteName":{"type":"string"}},"description":"In Schema for service: updatePartyGroup request"},"api.response.updatePartyGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updatePartyGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updatePartyGroup":{"post":{"tags":["Exported Services"],"summary":"Update a PartyGroup","description":"Update a PartyGroup","operationId":"updatePartyGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updatePartyGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updatePartyGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updatePartyGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

\
&#x20;           Update a Relationship between two Parties;\
&#x20;           if partyIdFrom is not specified the partyId of the current userLogin will be used;\
&#x20;           if roleTypeIds are not specified they will default to "\_NA\_".\
&#x20;           If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR\_REL\_UPDATE permission.\
&#x20;      &#x20;
------------------

> \
> &#x20;           Update a Relationship between two Parties;\
> &#x20;           if partyIdFrom is not specified the partyId of the current userLogin will be used;\
> &#x20;           if roleTypeIds are not specified they will default to "\_NA\_".\
> &#x20;           If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR\_REL\_UPDATE permission.\
> &#x20;      &#x20;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updatePartyRelationship":{"required":["fromDate","partyIdTo"],"type":"object","properties":{"roleTypeIdTo":{"type":"string"},"partyIdFrom":{"type":"string"},"comments":{"type":"string"},"positionTitle":{"type":"string"},"permissionsEnumId":{"type":"string"},"priorityTypeId":{"type":"string"},"roleTypeIdFrom":{"type":"string"},"thruDate":{"type":"string","format":"date"},"securityGroupId":{"type":"string"},"relationshipName":{"type":"string"},"fromDate":{"type":"string","format":"date"},"partyRelationshipTypeId":{"type":"string"},"statusId":{"type":"string"},"partyIdTo":{"type":"string"}},"description":"In Schema for service: updatePartyRelationship request"},"api.response.updatePartyRelationship.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updatePartyRelationship response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updatePartyRelationship":{"post":{"tags":["Exported Services"],"summary":"\n            Update a Relationship between two Parties;\n            if partyIdFrom is not specified the partyId of the current userLogin will be used;\n            if roleTypeIds are not specified they will default to \"_NA_\".\n            If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.\n        ","description":"\n            Update a Relationship between two Parties;\n            if partyIdFrom is not specified the partyId of the current userLogin will be used;\n            if roleTypeIds are not specified they will default to \"_NA_\".\n            If a partyIdFrom is passed in, it will be used if the userLogin has PARTYMGR_REL_UPDATE permission.\n        ","operationId":"updatePartyRelationship","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updatePartyRelationship","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updatePartyRelationship"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updatePartyRelationship.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Person

> Update a Person

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updatePerson":{"required":["firstName"],"type":"object","properties":{"yearsWithEmployer":{"type":"integer","format":"int32"},"lastName":{"type":"string"},"occupation":{"type":"string"},"employmentStatusEnumId":{"type":"string"},"gender":{"type":"string"},"socialSecurityNumber":{"type":"string"},"description":{"type":"string"},"suffix":{"type":"string"},"mothersMaidenName":{"type":"string"},"existingCustomer":{"type":"string"},"middleNameLocal":{"type":"string"},"residenceStatusEnumId":{"type":"string"},"preferredCurrencyUomId":{"type":"string"},"nickname":{"type":"string"},"partyId":{"type":"string"},"height":{"type":"number"},"memberId":{"type":"string"},"passportNumber":{"type":"string"},"comments":{"type":"string"},"lastNameLocal":{"type":"string"},"monthsWithEmployer":{"type":"integer","format":"int32"},"externalId":{"type":"string"},"weight":{"type":"number"},"birthDate":{"type":"string"},"otherLocal":{"type":"string"},"firstName":{"type":"string"},"anniversaryDate":{"type":"string"},"statusId":{"type":"string"},"cardId":{"type":"string"},"ranking":{"type":"integer","format":"int32"},"passportExpireDate":{"type":"string"},"firstNameLocal":{"type":"string"},"middleName":{"type":"string"},"salutation":{"type":"string"},"personalTitle":{"type":"string"},"totalYearsWorkExperience":{"type":"number"},"deceasedDate":{"type":"string"},"maritalStatus":{"type":"string"}},"description":"In Schema for service: updatePerson request"},"api.response.updatePerson.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updatePerson response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updatePerson":{"post":{"tags":["Exported Services"],"summary":"Update a Person","description":"Update a Person","operationId":"updatePerson","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updatePerson","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updatePerson"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updatePerson.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a PostalAddress.

> Update a PostalAddress.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updatePostalAddressContactMech":{"required":["contactMechId"],"type":"object","properties":{"countryGeoId":{"type":"string"},"houseNumberExt":{"type":"string"},"city":{"type":"string"},"address2":{"type":"string"},"address1":{"type":"string"},"latitude":{"type":"number"},"postalCodeGeoId":{"type":"string"},"postalCode":{"type":"string"},"encodedAddressKey":{"type":"string"},"houseNumber":{"type":"integer","format":"int32"},"postalCodeExt":{"type":"string"},"contactMechId":{"type":"string"},"attnName":{"type":"string"},"countyGeoId":{"type":"string"},"directions":{"type":"string"},"toName":{"type":"string"},"cityGeoId":{"type":"string"},"municipalityGeoId":{"type":"string"},"stateProvinceGeoId":{"type":"string"},"geoPointId":{"type":"string"},"longitude":{"type":"number"}},"description":"In Schema for service: updatePostalAddressContactMech request"},"api.response.updatePostalAddressContactMech.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updatePostalAddressContactMech response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updatePostalAddressContactMech":{"post":{"tags":["Exported Services"],"summary":"Update a PostalAddress.","description":"Update a PostalAddress.","operationId":"updatePostalAddressContactMech","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updatePostalAddressContactMech","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updatePostalAddressContactMech"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updatePostalAddressContactMech.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Product Store

> Update a Product Store

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateProductStore":{"required":["productStoreId"],"type":"object","properties":{"requireCustomerRole":{"type":"string"},"viewCartOnAdd":{"type":"string"},"companyName":{"type":"string"},"headerDeclinedStatus":{"type":"string"},"requireInventory":{"type":"string"},"allowSplit":{"type":"string"},"autoApproveInvoice":{"type":"string"},"checkInventory":{"type":"string"},"addToCartRemoveIncompat":{"type":"string"},"enableAutoSuggestionList":{"type":"string"},"defaultSalesChannelEnumId":{"type":"string"},"autoApproveOrder":{"type":"string"},"allowPassword":{"type":"string"},"oldHeaderLogo":{"type":"string"},"showTaxIsExempt":{"type":"string"},"enablePreOrderAutoReleasing":{"type":"string"},"autoSaveCart":{"type":"string"},"inventoryFacilityId":{"type":"string"},"oldHeaderMiddleBackground":{"type":"string"},"headerApprovedStatus":{"type":"string"},"defaultTimeZoneString":{"type":"string"},"oldStyleSheet":{"type":"string"},"showCheckoutGiftOptions":{"type":"string"},"prorateTaxes":{"type":"string"},"itemDeclinedStatus":{"type":"string"},"manualAuthIsCapture":{"type":"string"},"storeDomain":{"type":"string"},"showOutOfStockProducts":{"type":"string"},"storeCreditAccountEnumId":{"type":"string"},"itemApprovedStatus":{"type":"string"},"allowComment":{"type":"string"},"splitPayPrefPerShpGrp":{"type":"string"},"storeCreditValidDays":{"type":"integer","format":"int32"},"managedByLot":{"type":"string"},"authFraudMessage":{"type":"string"},"reqShipAddrForDigItems":{"type":"string"},"enableBrokering":{"type":"string"},"oneInventoryFacility":{"type":"string"},"autoSetFacility":{"type":"string"},"autoInvoiceDigitalItems":{"type":"string"},"orderNumberPrefix":{"type":"string"},"subtitle":{"type":"string"},"reserveOrderEnumId":{"type":"string"},"productIdentifierEnumId":{"type":"string"},"isDemoStore":{"type":"string"},"retryFailedAuths":{"type":"string"},"selectPaymentTypePerItem":{"type":"string"},"enableExternalPromotion":{"type":"string"},"balanceResOnOrderCreation":{"type":"string"},"explodeOrderItems":{"type":"string"},"autoApproveReviews":{"type":"string"},"usePrimaryEmailUsername":{"type":"string"},"termTypeId":{"type":"string"},"restockingFeePercentage":{"type":"number"},"headerCancelStatus":{"type":"string"},"title":{"type":"string"},"primaryStoreGroupId":{"type":"string"},"oldHeaderRightBackground":{"type":"string"},"enableDigProdUpload":{"type":"string"},"autoOrderCcTryOtherCards":{"type":"string"},"autoOrderCcTryLaterMax":{"type":"integer","format":"int32"},"restockingFeeFixed":{"type":"number"},"digitalItemApprovedStatus":{"type":"string"},"reserveInventory":{"type":"string"},"storeName":{"type":"string"},"ecomThemeId":{"type":"string"},"productStoreId":{"type":"string"},"storeLogoImageUrl":{"type":"string"},"isImmediatelyFulfilled":{"type":"string"},"defaultPassword":{"type":"string"},"autoOrderCcTryExp":{"type":"string"},"itemCancelStatus":{"type":"string"},"authDeclinedMessage":{"type":"string"},"prodSearchExcludeVariants":{"type":"string"},"shipIfCaptureFails":{"type":"string"},"daysToReturn":{"type":"integer","format":"int32"},"catalogUrlMountPoint":{"type":"string"},"showPricesWithVatTax":{"type":"string"},"externalId":{"type":"string"},"orderDecimalQuantity":{"type":"string"},"defaultCurrencyUomId":{"type":"string"},"prorateShipping":{"type":"string"},"digProdUploadCategoryId":{"type":"string"},"reqReturnInventoryReceive":{"type":"string"},"authErrorMessage":{"type":"string"},"setOwnerUponIssuance":{"type":"string"},"checkGcBalance":{"type":"string"},"addToCartReplaceUpsell":{"type":"string"},"autoOrderCcTryLaterNsf":{"type":"string"},"vatTaxAuthGeoId":{"type":"string"},"capturePmntsOnOrdApproval":{"type":"string"},"vatTaxAuthPartyId":{"type":"string"},"daysToCancelNonPay":{"type":"integer","format":"int32"},"requirementMethodEnumId":{"type":"string"},"defaultLocaleString":{"type":"string"},"payToPartyId":{"type":"string"},"autoAcceptReturn":{"type":"string"}},"description":"In Schema for service: updateProductStore request"},"api.response.updateProductStore.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateProductStore response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateProductStore":{"post":{"tags":["Exported Services"],"summary":"Update a Product Store","description":"Update a Product Store","operationId":"updateProductStore","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateProductStore","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateProductStore"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateProductStore.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a ProductStoreFacility

> Update a ProductStoreFacility

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateProductStoreFacility":{"required":["facilityId","fromDate","productStoreId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"facilityId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"productStoreId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateProductStoreFacility request"},"api.response.updateProductStoreFacility.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateProductStoreFacility response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateProductStoreFacility":{"post":{"tags":["Exported Services"],"summary":"Update a ProductStoreFacility","description":"Update a ProductStoreFacility","operationId":"updateProductStoreFacility","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateProductStoreFacility","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateProductStoreFacility"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateProductStoreFacility.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a ProductStoreFacilityGroup

> Update a ProductStoreFacilityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateProductStoreFacilityGroup":{"required":["facilityGroupId","fromDate","productStoreId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"sequenceNumber":{"type":"integer","format":"int32"},"facilityGroupId":{"type":"string"},"productStoreId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateProductStoreFacilityGroup request"},"api.response.updateProductStoreFacilityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateProductStoreFacilityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateProductStoreFacilityGroup":{"post":{"tags":["Exported Services"],"summary":"Update a ProductStoreFacilityGroup","description":"Update a ProductStoreFacilityGroup","operationId":"updateProductStoreFacilityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateProductStoreFacilityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateProductStoreFacilityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateProductStoreFacilityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Product Store Role

> Update a Product Store Role

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateProductStoreRole":{"required":["fromDate","partyId","productStoreId","roleTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"roleTypeId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"productStoreId":{"type":"string"},"partyId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateProductStoreRole request"},"api.response.updateProductStoreRole.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateProductStoreRole response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateProductStoreRole":{"post":{"tags":["Exported Services"],"summary":"Update a Product Store Role","description":"Update a Product Store Role","operationId":"updateProductStoreRole","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateProductStoreRole","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateProductStoreRole"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateProductStoreRole.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a ProductStoreSetting

> Update a ProductStoreSetting

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateProductStoreSetting":{"required":["productStoreId","settingTypeEnumId"],"type":"object","properties":{"settingValue":{"type":"string"},"productStoreId":{"type":"string"},"settingTypeEnumId":{"type":"string"}},"description":"In Schema for service: updateProductStoreSetting request"},"api.response.updateProductStoreSetting.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateProductStoreSetting response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateProductStoreSetting":{"post":{"tags":["Exported Services"],"summary":"Update a ProductStoreSetting","description":"Update a ProductStoreSetting","operationId":"updateProductStoreSetting","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateProductStoreSetting","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateProductStoreSetting"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateProductStoreSetting.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a Product Store Shipment Method

> Update a Product Store Shipment Method

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateProductStoreShipMeth":{"required":["productStoreShipMethId"],"type":"object","properties":{"companyPartyId":{"type":"string"},"productStoreShipMethId":{"type":"string"},"allowancePercent":{"type":"number"},"shipmentCustomMethodId":{"type":"string"},"includeFeatureGroup":{"type":"string"},"minTotal":{"type":"number"},"minWeight":{"type":"number"},"requireCompanyAddr":{"type":"string"},"maxSize":{"type":"number"},"excludeGeoId":{"type":"string"},"isShippingWeightRequired":{"type":"string"},"shipmentGatewayConfigId":{"type":"string"},"minSize":{"type":"number"},"allowCompanyAddr":{"type":"string"},"productStoreId":{"type":"string"},"minimumPrice":{"type":"number"},"partyId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"excludeFeatureGroup":{"type":"string"},"sequenceNumber":{"type":"integer","format":"int32"},"roleTypeId":{"type":"string"},"allowUspsAddr":{"type":"string"},"maxWeight":{"type":"number"},"serviceName":{"type":"string"},"thruDate":{"type":"string","format":"date"},"fromDate":{"type":"string","format":"date"},"includeGeoId":{"type":"string"},"maxTotal":{"type":"number"},"requireUspsAddr":{"type":"string"},"configProps":{"type":"string"},"includeNoChargeItems":{"type":"string"},"isTrackingRequired":{"type":"string"}},"description":"In Schema for service: updateProductStoreShipMeth request"},"api.response.updateProductStoreShipMeth.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateProductStoreShipMeth response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateProductStoreShipMeth":{"post":{"tags":["Exported Services"],"summary":"Update a Product Store Shipment Method","description":"Update a Product Store Shipment Method","operationId":"updateProductStoreShipMeth","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateProductStoreShipMeth","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateProductStoreShipMeth"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateProductStoreShipMeth.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Create Order Data based on API input parameters

> Create Order Data based on API input parameters

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateSalesOrder":{"required":["order"],"type":"object","properties":{"order":{"title":"The Root Schema","required":["shipGroup","billTo"],"type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"},"channel":{"title":"The Channel Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"priority":{"title":"The Priority Schema","type":"string"},"orderDate":{"title":"The Orderdate Schema","type":"string"},"entryDate":{"title":"The Entrydate Schema","type":"string"},"expireDate":{"title":"The Expiredate Schema","type":"string"},"statusId":{"title":"The Statusid Schema","type":"string"},"productStoreId":{"title":"The Productstoreid Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"remainingSubTotal":{"title":"The Remainingsubtotal Schema","type":"number"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"shipGroup":{"title":"The Shipgroup Schema","type":"array","items":{"title":"The Items Schema","required":["shipTo","items"],"type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"},"maySplit":{"title":"The Maysplit Schema","type":"string"},"shipBy":{"title":"The Shipby Schema","type":"string"},"shipAfter":{"title":"The Shipafter Schema","type":"string"},"carrierPartyId":{"title":"The Carrierpartyid Schema","type":"string"},"trackingNumber":{"title":"The Trackingnumber Schema","type":"string"},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"phoneNumber":{"title":"The Phonenumber Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"productId":{"title":"The Productid Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"number"},"unitListPrice":{"title":"The Unitlistprice Schema","type":"number"},"unitPrice":{"title":"The Unitprice Schema","type":"number"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}}}}},"orderAdjustments":{"title":"The Orderadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}},"orderPaymentPref":{"title":"The Orderpaymentpref Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"paymentMethodTypeId":{"title":"The Paymentmethodtypeid Schema","type":"string"},"paymentMode":{"title":"The Paymentmode Schema","type":"string"},"cardName":{"title":"The Cardname Schema","type":"string"},"code":{"title":"The Code Schema","type":"string"},"maxAmount":{"title":"The Maxamount Schema","type":"number"},"statusId":{"title":"The Statusid Schema","type":"string"}}}},"billTo":{"title":"The Billto Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"phoneNumber":{"title":"The Phonenumber Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}}}}},"description":"In Schema for service: updateSalesOrder request"},"api.response.updateSalesOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"order":{"title":"The Root Schema","required":["shipGroup","billTo"],"type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"},"channel":{"title":"The Channel Schema","type":"string"},"customerId":{"title":"The Customerid Schema","type":"string"},"customerExternalId":{"title":"The Customerexternalid Schema","type":"string"},"priority":{"title":"The Priority Schema","type":"string"},"orderDate":{"title":"The Orderdate Schema","type":"string"},"entryDate":{"title":"The Entrydate Schema","type":"string"},"expireDate":{"title":"The Expiredate Schema","type":"string"},"statusId":{"title":"The Statusid Schema","type":"string"},"productStoreId":{"title":"The Productstoreid Schema","type":"string"},"currencyCode":{"title":"The Currencycode Schema","type":"string"},"remainingSubTotal":{"title":"The Remainingsubtotal Schema","type":"number"},"grandTotal":{"title":"The Grandtotal Schema","type":"number"},"shipGroup":{"title":"The Shipgroup Schema","type":"array","items":{"title":"The Items Schema","required":["shipTo","items"],"type":"object","properties":{"facilityId":{"title":"The Facilityid Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"},"maySplit":{"title":"The Maysplit Schema","type":"string"},"shipBy":{"title":"The Shipby Schema","type":"string"},"shipAfter":{"title":"The Shipafter Schema","type":"string"},"carrierPartyId":{"title":"The Carrierpartyid Schema","type":"string"},"trackingNumber":{"title":"The Trackingnumber Schema","type":"string"},"shipTo":{"title":"The Shipto Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"phoneNumber":{"title":"The Phonenumber Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}},"items":{"title":"The Items Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"itemSeqId":{"title":"The Itemseqid Schema","type":"string"},"productId":{"title":"The Productid Schema","type":"string"},"sku":{"title":"The Sku Schema","type":"string"},"status":{"title":"The Status Schema","type":"string"},"quantity":{"title":"The Quantity Schema","type":"number"},"unitListPrice":{"title":"The Unitlistprice Schema","type":"number"},"unitPrice":{"title":"The Unitprice Schema","type":"number"},"itemAdjustments":{"title":"The Itemadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}}}}}}}},"orderAdjustments":{"title":"The Orderadjustments Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"type":{"title":"The Type Schema","type":"string"},"comments":{"title":"The Comments Schema","type":"string"},"amount":{"title":"The Amount Schema","type":"number"},"sourcePercentage":{"title":"The Sourcepercentage Schema","type":"number"}}}},"orderPaymentPref":{"title":"The Orderpaymentpref Schema","type":"array","items":{"title":"The Items Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"paymentMethodTypeId":{"title":"The Paymentmethodtypeid Schema","type":"string"},"paymentMode":{"title":"The Paymentmode Schema","type":"string"},"cardName":{"title":"The Cardname Schema","type":"string"},"code":{"title":"The Code Schema","type":"string"},"maxAmount":{"title":"The Maxamount Schema","type":"number"},"statusId":{"title":"The Statusid Schema","type":"string"}}}},"billTo":{"title":"The Billto Schema","type":"object","properties":{"postalAddress":{"title":"The Postaladdress Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"email":{"title":"The Email Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}},"phoneNumber":{"title":"The Phonenumber Schema","type":"object","properties":{"id":{"title":"The Id Schema","type":"string"},"externalId":{"title":"The Externalid Schema","type":"string"}}}}}}}}}},"description":"Out Schema for service: updateSalesOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateSalesOrder":{"post":{"tags":["Exported Services"],"summary":"Create Order Data based on API input parameters","description":"Create Order Data based on API input parameters","operationId":"updateSalesOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateSalesOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateSalesOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateSalesOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Search Preference

> Update Search Preference

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateSearchPreference":{"required":["searchPrefId"],"type":"object","properties":{"searchPrefName":{"type":"string"},"isPublic":{"type":"string"},"searchPrefValue":{"type":"string"},"searchPrefId":{"type":"string"}},"description":"In Schema for service: updateSearchPreference request"},"api.response.updateSearchPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateSearchPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateSearchPreference":{"post":{"tags":["Exported Services"],"summary":"Update Search Preference","description":"Update Search Preference","operationId":"updateSearchPreference","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateSearchPreference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateSearchPreference"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateSearchPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a SecurityGroup

> Update a SecurityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateSecurityGroup":{"required":["groupId"],"type":"object","properties":{"groupName":{"type":"string"},"groupId":{"type":"string"},"description":{"type":"string"},"groupTypeEnumId":{"type":"string"}},"description":"In Schema for service: updateSecurityGroup request"},"api.response.updateSecurityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateSecurityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateSecurityGroup":{"post":{"tags":["Exported Services"],"summary":"Update a SecurityGroup","description":"Update a SecurityGroup","operationId":"updateSecurityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateSecurityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateSecurityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateSecurityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a SecurityPermission from a SecurityGroup

> Update a SecurityPermission from a SecurityGroup

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateSecurityPermissionToSecurityGroup":{"required":["fromDate","groupId","permissionId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"permissionId":{"type":"string"},"groupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateSecurityPermissionToSecurityGroup request"},"api.response.updateSecurityPermissionToSecurityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateSecurityPermissionToSecurityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateSecurityPermissionToSecurityGroup":{"post":{"tags":["Exported Services"],"summary":"Update a SecurityPermission from a SecurityGroup","description":"Update a SecurityPermission from a SecurityGroup","operationId":"updateSecurityPermissionToSecurityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateSecurityPermissionToSecurityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateSecurityPermissionToSecurityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateSecurityPermissionToSecurityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Shipping Information on Order View

> Update Shipping Information on Order View

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipGroupShipInfo":{"required":["contactMechId"],"type":"object","properties":{"shipmentMethod":{"type":"string"},"orderId":{"type":"string"},"oldContactMechId":{"type":"string"},"shipGroupSeqId":{"type":"string"},"contactMechId":{"type":"string"}},"description":"In Schema for service: updateShipGroupShipInfo request"},"api.response.updateShipGroupShipInfo.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShipGroupShipInfo response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipGroupShipInfo":{"post":{"tags":["Exported Services"],"summary":"Update Shipping Information on Order View","description":"Update Shipping Information on Order View","operationId":"updateShipGroupShipInfo","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipGroupShipInfo","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipGroupShipInfo"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipGroupShipInfo.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Shipment

> Update Shipment

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipment":{"required":["shipmentId"],"type":"object","properties":{"statusDate":{"type":"string","format":"date"},"partyIdFrom":{"type":"string"},"latestCancelDate":{"type":"string","format":"date"},"estimatedReadyDate":{"type":"string","format":"date"},"additionalShippingCharge":{"type":"number"},"estimatedArrivalWorkEffId":{"type":"string"},"destinationTelecomNumberId":{"type":"string"},"estimatedShipCost":{"type":"number"},"shipmentMethodTypeId":{"type":"string"},"destinationFacilityId":{"type":"string"},"estimatedShipWorkEffId":{"type":"string"},"addtlShippingChargeDesc":{"type":"string"},"originContactMechId":{"type":"string"},"externalId":{"type":"string"},"primaryReturnId":{"type":"string"},"originFacilityId":{"type":"string"},"carrierPartyId":{"type":"string"},"currencyUomId":{"type":"string"},"destinationContactMechId":{"type":"string"},"statusId":{"type":"string"},"originTelecomNumberId":{"type":"string"},"shipmentId":{"type":"string"},"primaryOrderId":{"type":"string"},"estimatedShipDate":{"type":"string","format":"date"},"partyIdTo":{"type":"string"},"shipmentTypeId":{"type":"string"},"estimatedArrivalDate":{"type":"string","format":"date"},"picklistBinId":{"type":"string"},"primaryShipGroupSeqId":{"type":"string"},"handlingInstructions":{"type":"string"},"eventDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateShipment request"},"api.response.updateShipment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"oldStatusId":{"type":"string"},"oldPrimaryOrderId":{"type":"string"},"oldOriginFacilityId":{"type":"string"},"shipmentId":{"type":"string"},"shipmentTypeId":{"type":"string"},"picklistBinId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"oldPrimaryShipGroupSeqId":{"type":"string"},"oldDestinationFacilityId":{"type":"string"}}}},"description":"Out Schema for service: updateShipment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipment":{"post":{"tags":["Exported Services"],"summary":"Update Shipment","description":"Update Shipment","operationId":"updateShipment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a ShipmentBoxType record

> Update a ShipmentBoxType record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipmentBoxType":{"required":["shipmentBoxTypeId"],"type":"object","properties":{"boxLength":{"type":"number"},"boxWeight":{"type":"number"},"dimensionUomId":{"type":"string"},"weightUomId":{"type":"string"},"description":{"type":"string"},"boxHeight":{"type":"number"},"boxWidth":{"type":"number"},"shipmentBoxTypeId":{"type":"string"}},"description":"In Schema for service: updateShipmentBoxType request"},"api.response.updateShipmentBoxType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShipmentBoxType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipmentBoxType":{"post":{"tags":["Exported Services"],"summary":"Update a ShipmentBoxType record","description":"Update a ShipmentBoxType record","operationId":"updateShipmentBoxType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipmentBoxType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipmentBoxType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipmentBoxType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update ShipmentItem

> Update ShipmentItem

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipmentItem":{"required":["shipmentId","shipmentItemSeqId"],"type":"object","properties":{"availableToPromise":{"type":"number"},"serialNumber":{"type":"string"},"quantity":{"type":"number"},"productId":{"type":"string"},"shipmentContentDescription":{"type":"string"},"shipmentId":{"type":"string"},"externalId":{"type":"string"},"shipmentItemSeqId":{"type":"string"}},"description":"In Schema for service: updateShipmentItem request"},"api.response.updateShipmentItem.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShipmentItem response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipmentItem":{"post":{"tags":["Exported Services"],"summary":"Update ShipmentItem","description":"Update ShipmentItem","operationId":"updateShipmentItem","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipmentItem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipmentItem"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipmentItem.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Updates A ShipmentMethodType

> Updates A ShipmentMethodType

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipmentMethodType":{"required":["shipmentMethodTypeId"],"type":"object","properties":{"parentTypeId":{"type":"string"},"sequenceNum":{"type":"integer","format":"int32"},"description":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: updateShipmentMethodType request"},"api.response.updateShipmentMethodType.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShipmentMethodType response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipmentMethodType":{"post":{"tags":["Exported Services"],"summary":"Updates A ShipmentMethodType","description":"Updates A ShipmentMethodType","operationId":"updateShipmentMethodType","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipmentMethodType","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipmentMethodType"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipmentMethodType.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update ShipmentPackageRouteSeg

> Update ShipmentPackageRouteSeg

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipmentPackageRouteSeg":{"required":["shipmentId","shipmentPackageSeqId","shipmentRouteSegmentId"],"type":"object","properties":{"packagePickupPrn":{"type":"string"},"packageServiceCost":{"type":"number"},"boxNumber":{"type":"string"},"trackingCode":{"type":"string"},"shipmentPackageSeqId":{"type":"string"},"packageOtherCost":{"type":"number"},"labelImageUrl":{"type":"string"},"shipmentRouteSegmentId":{"type":"string"},"packagePickupDate":{"type":"string","format":"date"},"internationalInvoiceUrl":{"type":"string"},"currencyUomId":{"type":"string"},"labelPrinted":{"type":"string"},"packageTransportCost":{"type":"number"},"shipmentId":{"type":"string"},"codAmount":{"type":"number"},"insuredAmount":{"type":"number"},"gatewayMessage":{"type":"string"},"gatewayStatus":{"type":"string"},"labelHtml":{"type":"string"}},"description":"In Schema for service: updateShipmentPackageRouteSeg request"},"api.response.updateShipmentPackageRouteSeg.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShipmentPackageRouteSeg response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipmentPackageRouteSeg":{"post":{"tags":["Exported Services"],"summary":"Update ShipmentPackageRouteSeg","description":"Update ShipmentPackageRouteSeg","operationId":"updateShipmentPackageRouteSeg","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipmentPackageRouteSeg","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipmentPackageRouteSeg"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipmentPackageRouteSeg.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update ShipmentRouteSegment

> Update ShipmentRouteSegment

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShipmentRouteSegment":{"required":["shipmentId","shipmentRouteSegmentId"],"type":"object","properties":{"actualOtherCost":{"type":"number"},"carrierDeliveryZone":{"type":"string"},"thirdPartyPostalCode":{"type":"string"},"destTelecomNumberId":{"type":"string"},"carrierRestrictionCodes":{"type":"string"},"trackingIdNumber":{"type":"string"},"deliveryId":{"type":"string"},"actualCarrierCode":{"type":"string"},"referenceNumber":{"type":"string"},"codCollectionAmount":{"type":"number"},"actualStartDate":{"type":"string","format":"date"},"carrierServiceStatusId":{"type":"string"},"trackingDigest":{"type":"string"},"shipmentMethodTypeId":{"type":"string"},"actualCost":{"type":"number"},"actualArrivalDate":{"type":"string","format":"date"},"carrierService":{"type":"string"},"actualServiceCost":{"type":"number"},"estimatedStartDate":{"type":"string","format":"date"},"originContactMechId":{"type":"string"},"isGenerateThirdPartyLabel":{"type":"string"},"codReturnLabelHtml":{"type":"string"},"actualTransportCost":{"type":"number"},"carrierRestrictionDesc":{"type":"string"},"billingWeightUomId":{"type":"string"},"homeDeliveryDate":{"type":"string","format":"date"},"originFacilityId":{"type":"string"},"carrierPartyId":{"type":"string"},"destFacilityId":{"type":"string"},"shipmentRouteSegmentId":{"type":"string"},"lastUpdatedDate":{"type":"string","format":"date"},"currencyUomId":{"type":"string"},"billingWeight":{"type":"number"},"thirdPartyCountryGeoCode":{"type":"string"},"originTelecomNumberId":{"type":"string"},"shipmentId":{"type":"string"},"isTrackingRequired":{"type":"string"},"thirdPartyAccountNumber":{"type":"string"},"homeDeliveryType":{"type":"string"},"estimatedArrivalDate":{"type":"string","format":"date"},"destContactMechId":{"type":"string"},"carrierAccountNumber":{"type":"string"},"updatedByUserLoginId":{"type":"string"}},"description":"In Schema for service: updateShipmentRouteSegment request"},"api.response.updateShipmentRouteSegment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShipmentRouteSegment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShipmentRouteSegment":{"post":{"tags":["Exported Services"],"summary":"Update ShipmentRouteSegment","description":"Update ShipmentRouteSegment","operationId":"updateShipmentRouteSegment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShipmentRouteSegment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShipmentRouteSegment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShipmentRouteSegment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

\
&#x20;               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.\
&#x20;          &#x20;
----------------------

> \
> &#x20;               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.\
> &#x20;          &#x20;

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShippingInformationOfShipGroup":{"required":["orderId","shipGroupSeqId"],"type":"object","properties":{"houseNumberExt":{"type":"string"},"orderId":{"type":"string"},"city":{"type":"string"},"latitude":{"type":"string"},"postalCodeGeoId":{"type":"string"},"postalCode":{"type":"string"},"houseNumber":{"type":"integer","format":"int32"},"isEdited":{"type":"string"},"postalCodeExt":{"type":"string"},"contactMechId":{"type":"string"},"shipmentMethod":{"type":"string"},"attnName":{"type":"string"},"countyGeoId":{"type":"string"},"toName":{"type":"string"},"cityGeoId":{"type":"string"},"partyId":{"type":"string"},"longitude":{"type":"string"},"countryGeoId":{"type":"string"},"keepLatitudeAndLongitude":{"type":"string"},"address2":{"type":"string"},"address1":{"type":"string"},"encodedAddressKey":{"type":"string"},"shipGroupSeqId":{"type":"string"},"contactMechPurposeTypeId":{"type":"string"},"directions":{"type":"string"},"municipalityGeoId":{"type":"string"},"stateProvinceGeoId":{"type":"string"},"carrierAccountNumber":{"type":"string"},"geoPointId":{"type":"string"}},"description":"In Schema for service: updateShippingInformationOfShipGroup request"},"api.response.updateShippingInformationOfShipGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"newContactMechId":{"type":"string"}}}},"description":"Out Schema for service: updateShippingInformationOfShipGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShippingInformationOfShipGroup":{"post":{"tags":["Exported Services"],"summary":"\n                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.\n            ","description":"\n                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.\n            ","operationId":"updateShippingInformationOfShipGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShippingInformationOfShipGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShippingInformationOfShipGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShippingInformationOfShipGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Shopify draft order.

> Update Shopify draft order.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShopifyDraftOrder":{"required":["draftOrderId","payload","shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"payload":{"type":"object"},"draftOrderId":{"type":"integer","format":"int32"}},"description":"In Schema for service: updateShopifyDraftOrder request"},"api.response.updateShopifyDraftOrder.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShopifyDraftOrder response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShopifyDraftOrder":{"post":{"tags":["Exported Services"],"summary":"Update Shopify draft order.","description":"Update Shopify draft order.","operationId":"updateShopifyDraftOrder","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShopifyDraftOrder","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShopifyDraftOrder"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShopifyDraftOrder.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Creates a ShopifyProdLocActivation record

> Creates a ShopifyProdLocActivation record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShopifyProdLocActivation":{"required":["shopId","shopifyLocationId","shopifyProductId"],"type":"object","properties":{"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"},"shopifyProductId":{"type":"string"},"activated":{"type":"string"}},"description":"In Schema for service: updateShopifyProdLocActivation request"},"api.response.updateShopifyProdLocActivation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"},"shopifyProductId":{"type":"string"}}}},"description":"Out Schema for service: updateShopifyProdLocActivation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShopifyProdLocActivation":{"post":{"tags":["Exported Services"],"summary":"Creates a ShopifyProdLocActivation record","description":"Creates a ShopifyProdLocActivation record","operationId":"updateShopifyProdLocActivation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShopifyProdLocActivation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShopifyProdLocActivation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShopifyProdLocActivation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a ShopifyShopCarrierShipment record

> Update a ShopifyShopCarrierShipment record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShopifyShopCarrierShipment":{"required":["shopId","shopifyShippingMethod"],"type":"object","properties":{"carrierPartyId":{"type":"string"},"shopifyShippingMethod":{"type":"string"},"shopId":{"type":"string"},"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: updateShopifyShopCarrierShipment request"},"api.response.updateShopifyShopCarrierShipment.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShopifyShopCarrierShipment response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShopifyShopCarrierShipment":{"post":{"tags":["Exported Services"],"summary":"Update a ShopifyShopCarrierShipment record","description":"Update a ShopifyShopCarrierShipment record","operationId":"updateShopifyShopCarrierShipment","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShopifyShopCarrierShipment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShopifyShopCarrierShipment"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShopifyShopCarrierShipment.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a ShopifyShopLocation record

> Update a ShopifyShopLocation record

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateShopifyShopLocation":{"required":["facilityId","shopId"],"type":"object","properties":{"facilityId":{"type":"string"},"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"}},"description":"In Schema for service: updateShopifyShopLocation request"},"api.response.updateShopifyShopLocation.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateShopifyShopLocation response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateShopifyShopLocation":{"post":{"tags":["Exported Services"],"summary":"Update a ShopifyShopLocation record","description":"Update a ShopifyShopLocation record","operationId":"updateShopifyShopLocation","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateShopifyShopLocation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateShopifyShopLocation"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateShopifyShopLocation.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update system property

> Update system property

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateSystemProperty":{"required":["systemPropertyId","systemResourceId"],"type":"object","properties":{"systemPropertyValue":{"type":"string"},"systemResourceId":{"type":"string"},"description":{"type":"string"},"systemPropertyId":{"type":"string"}},"description":"In Schema for service: updateSystemProperty request"},"api.response.updateSystemProperty.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateSystemProperty response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateSystemProperty":{"post":{"tags":["Exported Services"],"summary":"Update system property","description":"Update system property","operationId":"updateSystemProperty","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateSystemProperty","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateSystemProperty"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateSystemProperty.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## First disable all userLogins, then enable the requested one.

> First disable all userLogins, then enable the requested one.

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateUserLoginStatus":{"required":["enabled","partyId","userLoginId"],"type":"object","properties":{"disabledDateTime":{"type":"string","format":"date"},"userLoginId":{"type":"string"},"successiveFailedLogins":{"type":"integer","format":"int32"},"userLdapDn":{"type":"string"},"externalAuthId":{"type":"string"},"requirePasswordChange":{"type":"string"},"partyId":{"type":"string"},"enabled":{"type":"string"}},"description":"In Schema for service: updateUserLoginStatus request"},"api.response.updateUserLoginStatus.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateUserLoginStatus response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateUserLoginStatus":{"post":{"tags":["Exported Services"],"summary":"First disable all userLogins, then enable the requested one.","description":"First disable all userLogins, then enable the requested one.","operationId":"updateUserLoginStatus","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateUserLoginStatus","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateUserLoginStatus"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateUserLoginStatus.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update a UserLogin to SecurityGroup Appl

> Update a UserLogin to SecurityGroup Appl

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateUserLoginToSecurityGroup":{"required":["fromDate","groupId","userLoginId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"userLoginId":{"type":"string"},"groupId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateUserLoginToSecurityGroup request"},"api.response.updateUserLoginToSecurityGroup.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateUserLoginToSecurityGroup response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateUserLoginToSecurityGroup":{"post":{"tags":["Exported Services"],"summary":"Update a UserLogin to SecurityGroup Appl","description":"Update a UserLogin to SecurityGroup Appl","operationId":"updateUserLoginToSecurityGroup","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateUserLoginToSecurityGroup","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateUserLoginToSecurityGroup"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateUserLoginToSecurityGroup.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Update Search Preference

> Update Search Preference

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.updateUserSearchPreference":{"required":["fromDate","searchPrefId","userLoginId","userSearchPrefTypeId"],"type":"object","properties":{"fromDate":{"type":"string","format":"date"},"userLoginId":{"type":"string"},"userSearchPrefTypeId":{"type":"string"},"searchPrefId":{"type":"string"},"thruDate":{"type":"string","format":"date"}},"description":"In Schema for service: updateUserSearchPreference request"},"api.response.updateUserSearchPreference.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: updateUserSearchPreference response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/updateUserSearchPreference":{"post":{"tags":["Exported Services"],"summary":"Update Search Preference","description":"Update Search Preference","operationId":"updateUserSearchPreference","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service updateUserSearchPreference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.updateUserSearchPreference"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.updateUserSearchPreference.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Upload And Import File

> Upload And Import File

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.uploadAndImportFile":{"required":["configId"],"type":"object","properties":{"scheduleNow":{"type":"boolean"},"fileProcessingDelay":{"type":"integer","format":"int32"},"_uploadedFile_contentType":{"type":"string"},"configId":{"type":"string"},"createdByJobId":{"type":"string"},"parameters":{"type":"object"},"continueOnError":{"type":"boolean"},"_uploadedFile_fileName":{"type":"string"}},"description":"In Schema for service: uploadAndImportFile request"},"api.response.uploadAndImportFile.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"uploadFileContentId":{"type":"string"},"configId":{"type":"string"},"filePath":{"type":"string"}}}},"description":"Out Schema for service: uploadAndImportFile response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/uploadAndImportFile":{"post":{"tags":["Exported Services"],"summary":"Upload And Import File","description":"Upload And Import File","operationId":"uploadAndImportFile","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service uploadAndImportFile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.uploadAndImportFile"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.uploadAndImportFile.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## POST /services/uploadPartyLogoImage

>

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.uploadPartyLogoImage":{"type":"object","properties":{"contentUrl":{"type":"string"},"_uploadedFile_contentType":{"type":"string"},"partyId":{"type":"string"},"_uploadedFile_fileName":{"type":"string"}},"description":"In Schema for service: uploadPartyLogoImage request"},"api.response.uploadPartyLogoImage.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{"properties":{"partyId":{"type":"string"}}}},"description":"Out Schema for service: uploadPartyLogoImage response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/uploadPartyLogoImage":{"post":{"tags":["Exported Services"],"summary":"","description":"","operationId":"uploadPartyLogoImage","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service uploadPartyLogoImage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.uploadPartyLogoImage"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.uploadPartyLogoImage.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```

## Main method to void shipping label from Third Party Shipping Services

> Main method to void shipping label from Third Party Shipping Services

```json
{"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"tags":[{"name":"Exported Services","description":"OFBiz services that are exposed via REST interface with export attribute set to true"}],"servers":[{"url":"https://10.106.39.100:443/rest","description":"Server Hosting the REST API"}],"security":[{"jwtToken":[]}],"components":{"securitySchemes":{"jwtToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"api.request.voidShipmentLabel":{"required":["shipmentId"],"type":"object","properties":{"shipmentId":{"type":"string"}},"description":"In Schema for service: voidShipmentLabel request"},"api.response.voidShipmentLabel.success":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"successMessage":{"type":"string","description":"Success Message"},"data":{}},"description":"Out Schema for service: voidShipmentLabel response"},"api.response.service.badrequest":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.unauthorized.invalidtoken":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.forbidden":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.methodnotallowed":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}},"api.response.service.unprocessableentity":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}},"paths":{"/services/voidShipmentLabel":{"post":{"tags":["Exported Services"],"summary":"Main method to void shipping label from Third Party Shipping Services","description":"Main method to void shipping label from Third Party Shipping Services","operationId":"voidShipmentLabel","parameters":[{"name":"Content-Type","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Request Body for service voidShipmentLabel","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.request.voidShipmentLabel"}}}},"responses":{"200":{"description":"Success response for the API call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.voidShipmentLabel.success"}}}},"400":{"description":"Bad Request: Due to malformed request syntax or invalid request message framing or incorrect request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.badrequest"}}}},"401":{"description":"Unauthorized: Access is denied due to invalid or absent Authorization header.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.unauthorized.invalidtoken"}}}},"403":{"description":"Forbidden: Insufficient rights to perform this API call.","headers":{"WWW-Authenticate":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.forbidden"}}}},"405":{"description":"Method Not Allowed: Service called with HTTP method other than the declared one.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.methodnotallowed"}}}},"422":{"description":"Unprocessable Entity: Error indicating semantical errors. Request is syntactically correct though.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/api.response.service.unprocessableentity"}}}}},"deprecated":false}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/legacy-oms/exported-services.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.