# Models ## The api.response.createOrderIndex.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.findProductById object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.indexDeploymentData.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.removeClientRegistrationToken object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.removeClientRegistrationToken":{"required":["applicationId","deviceId"],"type":"object","properties":{"applicationId":{"type":"string"},"deviceId":{"type":"string"}},"description":"In Schema for service: removeClientRegistrationToken request"}}}} ``` ## The api.request.createCarrierShipmentMethod object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createOrderAppeasement.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateShipmentRouteSegment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.subscribeFileStatusUpdateWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShopifyProdLocActivation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.bulkRejectStoreOutstandingOrders object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.allocateOrderItemToFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.bulkPackStoreFulfillmentOrders object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.bulkPackStoreFulfillmentOrders":{"type":"object","properties":{"shipmentIds":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: bulkPackStoreFulfillmentOrders request"}}}} ``` ## The api.request.createDataManagerConfig object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateCarrierGeoMapping.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteCarrierShipmentMethod object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createShopifyProdLocActivation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createShipmentBoxType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacilitiesToGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.clearCacheLineByValue.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateShopifyShopLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateProductStore.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.pullAndReportEntitySyncData object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createUpdateOrderAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateOISGIRIFulfillmentStatus object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.clearCacheLineByCondition object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.clearCacheLineByCondition":{"required":["entityName"],"type":"object","properties":{"entityName":{"type":"string"},"distribute":{"type":"boolean"}},"description":"In Schema for service: clearCacheLineByCondition request"}}}} ``` ## The api.request.createUpdatePartyEmailAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.resetPassword.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateUserLoginStatus object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.removePartyUserPermission object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.removePartyUserPermission":{"required":["groupId","userLoginId"],"type":"object","properties":{"userLoginId":{"type":"string"},"groupId":{"type":"string"}},"description":"In Schema for service: removePartyUserPermission request"}}}} ``` ## The api.response.updateOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.oldRejectOrderItems object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.oldRejectOrderItems":{"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: oldRejectOrderItems request"}}}} ``` ## The api.response.removeShopifyWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createSalesOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteExternalFulfillmentOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteExternalFulfillmentOrderItem":{"required":["externalFulfillmentOrderItemId"],"type":"object","properties":{"externalFulfillmentOrderItemId":{"type":"string"}},"description":"In Schema for service: deleteExternalFulfillmentOrderItem request"}}}} ``` ## The api.request.updateFacilitiesToGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.updateFacilitiesToGroup":{"required":["payload"],"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: updateFacilitiesToGroup request"}}}} ``` ## The api.request.updatePostalAddressContactMech object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createOrderItemAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.rejectOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.inventoryLevelUpdateFromShopify.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.setupShopifyShop.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.removeCategoryProducts object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createCommunicationEventOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createProductIndex.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.voidShipmentLabel object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.voidShipmentLabel":{"required":["shipmentId"],"type":"object","properties":{"shipmentId":{"type":"string"}},"description":"In Schema for service: voidShipmentLabel request"}}}} ``` ## The api.response.deleteShipmentMethodType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createShopifyShopLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createUpdatePartyEmailAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createPostalAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.storeClientRegistrationToken.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createRelationship.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createCommunicationEventOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createCommunicationEventOrder":{"required":["communicationEventId","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"communicationEventId":{"type":"string"}},"description":"In Schema for service: createCommunicationEventOrder request"}}}} ``` ## The api.request.subscribeFileStatusUpdateWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.subscribeFileStatusUpdateWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"}},"description":"In Schema for service: subscribeFileStatusUpdateWebhook request"}}}} ``` ## The api.response.createFacilityTelecomNumber.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteDataManagerMapping object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteDataManagerMapping":{"required":["mappingPrefId"],"type":"object","properties":{"mappingPrefId":{"type":"string"}},"description":"In Schema for service: deleteDataManagerMapping request"}}}} ``` ## The api.request.subscribeShopifyWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createOrderAppeasement object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createUpdateOrderAdjustment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.expireFacilityCalendar.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createShopifyShopCarrierShipment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.importJsonListData.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.subscribeReturnOrderShopifyWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createShopifyShopLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createShopifyShopLocation":{"type":"object","properties":{"facilityId":{"type":"string"},"shopifyLocationId":{"type":"string"},"shopId":{"type":"string"}},"description":"In Schema for service: createShopifyShopLocation request"}}}} ``` ## The api.request.createShopifyOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createShopifyOrder":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"payload":{"type":"object"}},"description":"In Schema for service: createShopifyOrder request"}}}} ``` ## The api.response.createSystemProperty.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.ensurePartyRole object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.ensurePartyRole":{"required":["partyId","roleTypeId"],"type":"object","properties":{"roleTypeId":{"type":"string"},"partyId":{"type":"string"}},"description":"In Schema for service: ensurePartyRole request"}}}} ``` ## The api.response.addCategoryProducts.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createShipmentMethodType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.uploadPartyLogoImage object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.importProductFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.addUserLoginToSecurityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.importProductFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.bulkRejectStoreInProgressOrders.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateOrderPaymentPreferenceV2 object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getDAGRunStatus.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addCategoryProducts object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.service.badrequest object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The api.request.subscribeReturnOrderShopifyWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createShopifyReturn object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createSecurityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.subscribeCancelOrderShopifyWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.unauthorized.invalidtoken object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The api.response.getProductInventoryAvailable.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.picklistDataSetup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createProductStoreFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateFacilityTelecomNumber.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updatePerson.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createPostalAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createShopifyShopCarrierShipment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateSecurityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createUpdateOrderAdjustment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createFacilityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShipment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateSalesOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createFacilityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.recordProductVariance object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createOrderAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createIncomingShipment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createIncomingShipment":{"required":["payload"],"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: createIncomingShipment request"}}}} ``` ## The api.request.updateFacilityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.addFacilityToGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.getServerTimeZone.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.subscribeShopifyWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteEnumerationGroupMember object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateProductStoreSetting object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updatePartyGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updatePerson object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.deleteFacilityLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteFacilityLocation":{"required":["facilityId","locationSeqId"],"type":"object","properties":{"facilityId":{"type":"string"},"locationSeqId":{"type":"string"}},"description":"In Schema for service: deleteFacilityLocation request"}}}} ``` ## The api.request.createDataManagerMapping object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.service.methodnotallowed object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The api.response.addShipmentPackage.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShipGroupShipInfo object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.releaseOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.testCommit.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.uploadAndImportFile.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateProductStoreRole object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacilityLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateProductStoreSetting.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.addSecurityPermissionToSecurityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createOrderAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateFacilityIdentification object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updatePostalAddressContactMech.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateFacilityTelecomNumber object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.storeClientRegistrationToken object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createProductStoreSetting.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.subscribeTopic object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.subscribeTopic":{"required":["applicationId","topicName"],"type":"object","properties":{"topicName":{"type":"string"},"applicationId":{"type":"string"}},"description":"In Schema for service: subscribeTopic request"}}}} ``` ## The api.request.indexWebhookErrorMessage object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.calendarDataSetup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addShipmentPackage object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createFacilityCalendar object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.setReasonIdOnReturnItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createSecurityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.sendReadyToPickupItemNotification.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.setReasonIdOnReturnItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.uploadPartyLogoImage.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.storeEntitySyncData.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShipmentPackageRouteSeg object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createRelationship object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateSearchPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShopifyShopCarrierShipment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createEnumerationGroupMember.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addPartyToFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.doRateShopping object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createShopifyProdLocActivation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateOISGIRIFulfillmentStatus.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.getGeoPointForPostalCode.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.ensurePartyRole.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.bulkApproveTransferOrders.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.setupShopifyShop object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.checkAndRejectOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createPurchaseShipment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.deleteShopifyShopCarrierShipment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.bulkAdjustInventoryLevelOnShopify object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.deleteProductStoreFacilityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createProductStoreFacilityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateProductStoreFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createFacilityContactMech object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.deleteShipmentItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteShipmentItem":{"required":["shipmentId","shipmentItemSeqId"],"type":"object","properties":{"shipmentId":{"type":"string"},"shipmentItemSeqId":{"type":"string"}},"description":"In Schema for service: deleteShipmentItem request"}}}} ``` ## The api.request.getFacilityIdByType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getFacilityIdByType":{"required":["identification"],"type":"object","properties":{"identification":{"type":"string"},"identificationType":{"type":"string"}},"description":"In Schema for service: getFacilityIdByType request"}}}} ``` ## The api.request.sendPickupScheduledNotification object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.sendPickupScheduledNotification":{"required":["shipmentId"],"type":"object","properties":{"emailType":{"type":"string"},"shipmentId":{"type":"string"}},"description":"In Schema for service: sendPickupScheduledNotification request"}}}} ``` ## The api.request.updateSecurityPermissionToSecurityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateShipment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteOrderItemAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createCarrierShipmentBoxType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.addPartyUserPermission.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createProductStoreFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createSecurityPermission.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createOrderIndex object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.unlockStoreFulfillmentOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.unlockStoreFulfillmentOrder":{"required":["orderId","picklistBinId"],"type":"object","properties":{"orderId":{"type":"string"},"picklistBinId":{"type":"string"}},"description":"In Schema for service: unlockStoreFulfillmentOrder request"}}}} ``` ## The api.response.indexExternalDeploymentData.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getInventoryAvailableByFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getCODOrderRemainingTotal.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.removePartyFromFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addPartyUserPermission object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacilityEmailAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.testScv object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.testScv":{"type":"object","properties":{"defaultValue":{"type":"number"},"message":{"type":"string"}},"description":"In Schema for service: testScv request"}}}} ``` ## The api.response.service.unprocessableentity object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The api.request.createFacilityLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.getServerTimeZone object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getServerTimeZone":{"type":"object","description":"In Schema for service: getServerTimeZone request"}}}} ``` ## The api.request.updatePartyRelationship object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateProductStoreFacilityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateShipmentMethodType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createProductStoreSetting object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getOrderIdByType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updatePartyRelationship.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateFacilityContactMech object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateUserLoginToSecurityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.unlinkReturnFromOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.addDataToSearchIndex.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateOrderItemFromShopify object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.updateOrderItemFromShopify":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"payload":{"type":"object"}},"description":"In Schema for service: updateOrderItemFromShopify request"}}}} ``` ## The api.response.updateEnumerationGroupMember.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateCarrierShipmentMethod object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createReturn object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createOISGIRIndex object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.reShipOrderItems.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.forbidden object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}}}} ``` ## The api.request.bulkRejectStoreInProgressOrders object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.resetPassword object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.generateManifests.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.appendOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.clearCacheLineByPrimaryKey.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateFacilityPostalAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.orderDataSetup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deleteOrderAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.packStoreFulfillmentOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateProductStoreRole.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.testScv.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.getInventoryAvailableByLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.rejectTransferOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.rejectTransferOrderItem":{"required":["orderId","orderItemSeqId"],"type":"object","properties":{"orderItemSeqId":{"type":"string"},"orderId":{"type":"string"}},"description":"In Schema for service: rejectTransferOrderItem request"}}}} ``` ## The api.request.storeEntitySyncData object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createDataManagerMapping.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.storeCalendarAssocDataSetup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createGcFulFillmentRecord object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createSecurityPermission object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createSecurityPermission":{"required":["permissionId"],"type":"object","properties":{"permissionId":{"type":"string"},"description":{"type":"string"}},"description":"In Schema for service: createSecurityPermission request"}}}} ``` ## The api.response.createUpdateOrderAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createCommercePartyRelationshipFrom object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateShopifyProdLocActivation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.receiveAndUpdateInventoryToShopify.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateUserSearchPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.unsubscribeTopic object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.unsubscribeTopic":{"required":["applicationId","topicName"],"type":"object","properties":{"topicName":{"type":"string"},"applicationId":{"type":"string"}},"description":"In Schema for service: unsubscribeTopic request"}}}} ``` ## The api.response.setCustomerDefaultStore.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.findProductById.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getProductFutureAtp object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getProductFutureAtp":{"required":["productId"],"type":"object","properties":{"isNewProduct":{"type":"string"},"productId":{"type":"string"}},"description":"In Schema for service: getProductFutureAtp request"}}}} ``` ## The api.response.deleteFacilityLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.bulkPackStoreFulfillmentOrders.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createEnumerationGroupMember object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacilityIdentification.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.picklistDataSetup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getInventoryAvailableByLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.getDAGRunStatus object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getDAGRunStatus":{"required":["dagId","dagRunId"],"type":"object","properties":{"dagRunId":{"type":"string"},"dagId":{"type":"string"}},"description":"In Schema for service: getDAGRunStatus request"}}}} ``` ## The api.request.getProductInventoryAvailable object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.checkAttributesAndApproveOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateCarrierGeoMapping object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.changeOrderItemStatus.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteCarrierShipmentBoxType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteCarrierShipmentBoxType":{"required":["partyId","shipmentBoxTypeId"],"type":"object","properties":{"partyId":{"type":"string"},"shipmentBoxTypeId":{"type":"string"}},"description":"In Schema for service: deleteCarrierShipmentBoxType request"}}}} ``` ## The api.response.createPurchaseShipment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateOrderItemShipGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createProductFacilityLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.removeClientRegistrationToken.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createUpdateShippingAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createPartyGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.getOrderIdByType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getOrderIdByType":{"required":["identification"],"type":"object","properties":{"identification":{"type":"string"},"identificationType":{"type":"string"}},"description":"In Schema for service: getOrderIdByType request"}}}} ``` ## The api.response.getInventoryAvailableByFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteFacilityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteFacilityGroup":{"required":["facilityGroupId"],"type":"object","properties":{"facilityGroupId":{"type":"string"}},"description":"In Schema for service: deleteFacilityGroup request"}}}} ``` ## The api.request.rejectOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.rejectOrderItem":{"type":"object","properties":{"payload":{"type":"object"},"rejectedComponents":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: rejectOrderItem request"}}}} ``` ## The api.request.setCustomerDefaultStore object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.unlinkReturnFromOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.unlinkReturnFromOrder":{"required":["returnId"],"type":"object","properties":{"returnId":{"type":"string"}},"description":"In Schema for service: unlinkReturnFromOrder request"}}}} ``` ## The api.response.updateDataManagerConfig.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.indexWebhookErrorMessage.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.removeCategoryProducts.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.generateCustomerOrderUpdateLink.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createShopifyReturn.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createExcludedOrderFacilityForOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.deleteExternalFulfillmentOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.oldCheckAndRejectOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.changeOrderStatus object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.rejectFulfillmentReadyOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteShopifyShopCarrierShipment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.uploadAndImportFile object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.recordInventoryCount object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateDataManagerConfig object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.cancelSalesOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.cancelScheduledJob object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.cancelScheduledJob":{"required":["jobId"],"type":"object","properties":{"jobId":{"type":"string"}},"description":"In Schema for service: cancelScheduledJob request"}}}} ``` ## The api.request.clearAllEntityCaches object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.clearAllEntityCaches":{"type":"object","properties":{"distribute":{"type":"boolean"}},"description":"In Schema for service: clearAllEntityCaches request"}}}} ``` ## The api.request.clearCacheLineByDummyPK object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.clearCacheLineByDummyPK":{"type":"object","properties":{"distribute":{"type":"boolean"}},"description":"In Schema for service: clearCacheLineByDummyPK request"}}}} ``` ## The api.response.createFacilityCalendar.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deleteDataManagerMapping.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.orderFulfillmentAllocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.packStoreFulfillmentOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.packStoreFulfillmentOrder":{"required":["orderId","picklistBinId"],"type":"object","properties":{"orderId":{"type":"string"},"picklistBinId":{"type":"string"}},"description":"In Schema for service: packStoreFulfillmentOrder request"}}}} ``` ## The api.request.createProductFacilityLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.importJsonListData object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.importJsonListData":{"required":["dataList"],"type":"object","properties":{"dataList":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: importJsonListData request"}}}} ``` ## The api.request.updateFacilityToGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateShipmentItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateFacilityLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.subscribeCreateOrderShopifyWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createIncomingShipment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.gatewayShipAddressValidationRequest.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateShippingInformationOfShipGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createNewUserLoginAndSetUserPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.deleteProductStoreFacilityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.pullAndReportEntitySyncData.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createFacilityIdentification object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createFacilityPostalAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.unsubscribeShopifyWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.removePartyUserPermission.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.checkAttributesAndApproveOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.checkAttributesAndApproveOrder":{"type":"object","properties":{"orderId":{"type":"string"},"attributes":{"type":"object"}},"description":"In Schema for service: checkAttributesAndApproveOrder request"}}}} ``` ## The api.response.createShopifyOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addFacilityToGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createUpdatePartyTelecomNumber object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateOrderAddressAndAppendAttributes.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateSystemProperty object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateOrderAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateShopifyDraftOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deleteOrderItemAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createCarrierShipmentMethod.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createCommercePartyRelationshipFrom.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateInventoryByIdentification object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateDataManagerMapping object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createFacilityIdentification.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createUserSearchPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.triggerDag.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.changeOrderStatus.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShipmentItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.bulkShipOrders object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.bulkShipOrders":{"type":"object","properties":{"shipmentId":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: bulkShipOrders request"}}}} ``` ## The api.request.deleteCarrierGeoMapping object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createPartyGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateUserLoginToSecurityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.orderFulfillmentAllocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createFacilityContactMech.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createProductStoreRole object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateSearchPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createDataManagerConfig.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteEnumeration object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteEnumeration":{"required":["enumId"],"type":"object","properties":{"enumId":{"type":"string"}},"description":"In Schema for service: deleteEnumeration request"}}}} ``` ## The api.request.deletePartyContactMech object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deletePartyContactMech":{"required":["contactMechId"],"type":"object","properties":{"partyId":{"type":"string"},"contactMechId":{"type":"string"}},"description":"In Schema for service: deletePartyContactMech request"}}}} ``` ## The api.response.updateFacilityToGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.removeFacilityFromGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.cancelOrderItems object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.testError.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.approveSalesOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.approveSalesOrder":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"},"confirmApprove":{"type":"string"}},"description":"In Schema for service: approveSalesOrder request"}}}} ``` ## The api.response.updateProductStoreFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateShipmentBoxType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deletePartyRole object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deletePartyRole":{"required":["partyId","roleTypeId"],"type":"object","properties":{"roleTypeId":{"type":"string"},"partyId":{"type":"string"}},"description":"In Schema for service: deletePartyRole request"}}}} ``` ## The api.response.createFacilityEmailAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.gatewayShipAddressValidationRequest object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createUpdateShopifyShop object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.oldRejectOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.oldRejectOrderItem":{"type":"object","properties":{"payload":{"type":"object"},"rejectedComponents":{"type":"array","items":{"type":"string"}}},"description":"In Schema for service: oldRejectOrderItem request"}}}} ``` ## The api.request.createShipmentReceipt object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.generateCustomerOrderUpdateLink object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.generateCustomerOrderUpdateLink":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"}},"description":"In Schema for service: generateCustomerOrderUpdateLink request"}}}} ``` ## The api.response.deleteCarrierGeoMapping.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.rejectTransferOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createSalesOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateProductStoreShipMeth object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.getUserPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.forceLogout object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.forceLogout":{"required":["userLoginId"],"type":"object","properties":{"userLoginId":{"type":"string"}},"description":"In Schema for service: forceLogout request"}}}} ``` ## The api.response.updateOrderItemAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createShipmentReceipt.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateSecurityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.oldCheckAndRejectOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.reShipOrderItems object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateSystemProperty.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShopifyShopLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createFacilityTelecomNumber object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createCommunicationEvent.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.setUserPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateShipmentMethodType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.addSecurityGroupToUserLogin object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.addSecurityGroupToUserLogin":{"required":["partyIdTo","securityGroupId"],"type":"object","properties":{"securityGroupId":{"type":"string"},"partyIdTo":{"type":"string"}},"description":"In Schema for service: addSecurityGroupToUserLogin request"}}}} ``` ## The api.response.deleteCarrierShipmentBoxType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.resetPicker.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateEnumeration object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacilityPostalAddress.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createExcludedOrderFacilityForOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.clearAllEntityCaches.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createRoleType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createUpdatePartyTelecomNumber.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateShipmentRouteSegment object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getShopifyDraftOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.addSecurityGroupToUserLogin.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createUpdateShippingAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createUserSearchPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getProductOnlineAtp object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getShippingLabel.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateFacilityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addSecurityPermissionToSecurityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.checkAndRejectOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createCommunicationEvent object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createUpdateShopifyShop.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.moveItemToParkingFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.indexExternalDeploymentData object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.resetPicker object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateUserLoginStatus.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deleteCarrierShipmentMethod.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.testError object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.testError":{"type":"object","description":"In Schema for service: testError request"}}}} ``` ## The api.request.deleteShopifyShopLocation object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateJobSandbox.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.bulkApproveTransferOrders object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createProductStoreShipMeth.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.sendOrderWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.getShopifyWebhooks.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.subscribeOrderPaidWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deletePartyContactMech.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createSystemProperty object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateFacilityEmailAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createReturn.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deleteEnumerationGroupMember.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateEnumerationGroupMember object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateAllOrderItems object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.approveSalesOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createNewUserLoginAndSetUserPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createProductIndex object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createProductIndex":{"type":"object","properties":{"productId":{"type":"string"},"indexVariants":{"type":"boolean"},"tenantId":{"type":"string"}},"description":"In Schema for service: createProductIndex request"}}}} ``` ## The api.response.createSearchPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.inventoryLevelUpdateFromShopify object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.deletePartyRole.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.setUserPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateJobSandbox object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.rejectOrderItems object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.rejectOrderItems":{"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: rejectOrderItems request"}}}} ``` ## The api.response.getUserPreference.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.moveItemToParkingFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateOrderItemShipGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.cancelOrderItems.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.removeFacilityFromGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.removeShopifyWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateShopifyDraftOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateProductStoreFacilityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.subscribeTopic.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.calendarDataSetup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.sendPickupScheduledNotification.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateOrderAddressAndAppendAttributes object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.sendReadyToPickupItemNotification object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.sendReadyToPickupItemNotification":{"required":["shipmentId"],"type":"object","properties":{"emailType":{"type":"string"},"shipmentId":{"type":"string"}},"description":"In Schema for service: sendReadyToPickupItemNotification request"}}}} ``` ## The api.response.createFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.subscribeCreateOrderShopifyWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.executeServiceFromAirflow\.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.unsubscribeTopic.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateDataManagerMapping.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateEnumeration.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.executeServiceFromAirflow object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.subscribeOrderPaidWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.subscribeOrderPaidWebhook":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"}},"description":"In Schema for service: subscribeOrderPaidWebhook request"}}}} ``` ## The api.response.rejectOrderItems.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateAllOrderItems.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateProductStoreShipMeth.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createRoleType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.subscribeCancelOrderShopifyWebhook.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getGeoPointForPostalCode object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getGeoPointForPostalCode":{"required":["countryCode","postalCode"],"type":"object","properties":{"countryCode":{"type":"string"},"postalCode":{"type":"string"}},"description":"In Schema for service: getGeoPointForPostalCode request"}}}} ``` ## The api.request.createProductStoreShipMeth object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createShipmentItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.cancelScheduledJob.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createOrderItemAttribute.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.bulkShipOrders.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.orderDataSetup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getProductFutureAtp.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.addProductToFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createFacilityLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateOrderAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateFacilityContactMech.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getShippingLabel object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getShippingLabel":{"required":["shipmentId"],"type":"object","properties":{"carrierPartyId":{"type":"string"},"shipmentId":{"type":"string"}},"description":"In Schema for service: getShippingLabel request"}}}} ``` ## The api.response.allocateOrderItemToFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.clearCacheLineByDummyPK.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addFacilitiesToGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.addFacilitiesToGroup":{"required":["payload"],"type":"object","properties":{"payload":{"type":"object"}},"description":"In Schema for service: addFacilitiesToGroup request"}}}} ``` ## The api.response.updateInventoryByIdentification.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateOrderPaymentPreferenceV2.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createShipmentBoxType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.unsubscribeShopifyWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.unsubscribeShopifyWebhook":{"required":["shopifyConfigId","topic"],"type":"object","properties":{"shopifyConfigId":{"type":"string"},"topic":{"type":"string"}},"description":"In Schema for service: unsubscribeShopifyWebhook request"}}}} ``` ## The api.request.updateShipmentBoxType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.changeOrderItemStatus object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.deleteEnumeration.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.rejectFulfillmentReadyOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.getProductOnlineAtp.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.removePartyFromFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.createProductStoreRole.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.bulkAdjustInventoryLevelOnShopify.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createSearchPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.createSearchPreference":{"type":"object","properties":{"searchPrefName":{"type":"string"},"isPublic":{"type":"string"},"searchPrefValue":{"type":"string"}},"description":"In Schema for service: createSearchPreference request"}}}} ``` ## The api.request.addProductToFacility object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.recordInventoryCount.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.bulkRejectStoreOutstandingOrders.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createShipmentItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.clearCacheLineByCondition.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateCarrierShipmentMethod.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.addPartyToFacility.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.deleteShipmentItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteOrderAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteOrderAttribute":{"required":["attrName","orderId"],"type":"object","properties":{"orderId":{"type":"string"},"attrName":{"type":"string"}},"description":"In Schema for service: deleteOrderAttribute request"}}}} ``` ## The api.request.addDataToSearchIndex object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.releaseOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateOrderItemFromShopify.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateProductStore object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createEnumeration object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.cancelOrderItem object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateShippingInformationOfShipGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateShopifyShopCarrierShipment.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.cancelOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createCarrierShipmentBoxType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.oldRejectOrderItems.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.updateSecurityPermissionToSecurityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.cancelSalesOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.cancelSalesOrder":{"required":["orderId"],"type":"object","properties":{"changeReason":{"type":"string"},"orderId":{"type":"string"}},"description":"In Schema for service: cancelSalesOrder request"}}}} ``` ## The api.response.updateShipGroupShipInfo.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.receiveAndUpdateInventoryToShopify object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.triggerDag object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.triggerDag":{"required":["endpoint"],"type":"object","properties":{"endpoint":{"type":"string"}},"description":"In Schema for service: triggerDag request"}}}} ``` ## The api.response.updateShipmentPackageRouteSeg.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.createFacilityEmailAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.getShopifyDraftOrder object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.voidShipmentLabel.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.testRollback.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.expireFacilityCalendar object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.updateUserSearchPreference object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.deleteShopifyShopLocation.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.deleteShipmentMethodType object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.deleteShipmentMethodType":{"required":["shipmentMethodTypeId"],"type":"object","properties":{"shipmentMethodTypeId":{"type":"string"}},"description":"In Schema for service: deleteShipmentMethodType request"}}}} ``` ## The api.response.deleteFacilityGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.storeCalendarAssocDataSetup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.getShopifyWebhooks object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getShopifyWebhooks":{"required":["shopifyConfigId"],"type":"object","properties":{"shopifyConfigId":{"type":"string"}},"description":"In Schema for service: getShopifyWebhooks request"}}}} ``` ## The api.response.oldRejectOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.sendOrderWebhook object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.sendOrderWebhook":{"required":["orderId","topicEnumId"],"type":"object","properties":{"orderId":{"type":"string"},"topicEnumId":{"type":"string"}},"description":"In Schema for service: sendOrderWebhook request"}}}} ``` ## The api.request.testRollback object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.testRollback":{"type":"object","properties":{"message":{"type":"string"}},"description":"In Schema for service: testRollback request"}}}} ``` ## The api.request.updatePartyGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.unlockStoreFulfillmentOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.appendOrderItem.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.unauthorized.noheader object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.response.unauthorized.noheader":{"type":"object","properties":{"statusCode":{"type":"integer","description":"HTTP Status Code","format":"int32"},"statusDescription":{"type":"string","description":"HTTP Status Code Description"},"errorType":{"type":"string","description":"Error Type for the error"},"errorMessage":{"type":"string","description":"Error Message"}}}}}} ``` ## The api.request.clearCacheLineByValue object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.clearCacheLineByValue":{"type":"object","properties":{"distribute":{"type":"boolean"}},"description":"In Schema for service: clearCacheLineByValue request"}}}} ``` ## The api.response.addFacilitiesToGroup.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createOISGIRIndex.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.generateManifests object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.getCODOrderRemainingTotal object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.getCODOrderRemainingTotal":{"required":["orderId"],"type":"object","properties":{"orderId":{"type":"string"}},"description":"In Schema for service: getCODOrderRemainingTotal request"}}}} ``` ## The api.request.testCommit object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.testCommit":{"type":"object","properties":{"message":{"type":"string"}},"description":"In Schema for service: testCommit request"}}}} ``` ## The api.response.getFacilityIdByType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createShipmentMethodType.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.recordProductVariance.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.clearCacheLineByPrimaryKey object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.clearCacheLineByPrimaryKey":{"required":["primaryKey"],"type":"object","properties":{"distribute":{"type":"boolean"},"primaryKey":{"type":"object"}},"description":"In Schema for service: clearCacheLineByPrimaryKey request"}}}} ``` ## The api.response.createEnumeration.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.createGcFulFillmentRecord.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.updateOrderItemAttribute object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.updateSalesOrder.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.response.doRateShopping.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.indexDeploymentData object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"api.request.indexDeploymentData":{"type":"object","properties":{"updateHandler":{"type":"string"},"coreName":{"type":"string"}},"description":"In Schema for service: indexDeploymentData request"}}}} ``` ## The api.request.createProductStoreFacilityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.response.forceLogout.success object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The api.request.addUserLoginToSecurityGroup object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ``` ## The api.request.createFacilityPostalAddress object ```json {"openapi":"3.0.1","info":{"title":"Commerce REST APIs","version":"1.0.0"},"components":{"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"}}}} ```