ProductStores

productStores

list ProductStoreShipmentMethView

get
Authorizations
Path parameters
productStoreIdstringRequired
Query parameters
pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

productStoreShipMethIdstringOptional
shipmentMethodTypeIdstringOptional
partyIdstringOptional
roleTypeIdstringOptional
companyPartyIdstringOptional
minWeightnumberOptional
maxWeightnumberOptional
minSizenumberOptional
maxSizenumberOptional
minTotalnumberOptional
maxTotalnumberOptional
allowUspsAddrstringOptional
requireUspsAddrstringOptional
allowCompanyAddrstringOptional
requireCompanyAddrstringOptional
includeNoChargeItemsstringOptional
includeFeatureGroupstringOptional
excludeFeatureGroupstringOptional
includeGeoIdstringOptional
excludeGeoIdstringOptional
serviceNamestringOptional
configPropsstringOptional
shipmentCustomMethodIdstringOptional
shipmentGatewayConfigIdstringOptional
sequenceNumbernumber · int64Optional
allowancePercentnumberOptional
minimumPricenumberOptional
fromDatestring · date-timeOptional
thruDatestring · date-timeOptional
isShippingWeightRequiredstringOptional
isTrackingRequiredstringOptional
descriptionstringOptional
parentTypeIdstringOptional
Responses
200
Success
application/json
get
GET /rest/s1/order-routing/productStores/{productStoreId}/shippingMethods HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
  {
    "_entity": "co.hotwax.product.store.ProductStoreShipmentMethView",
    "productStoreShipMethId": "text",
    "productStoreId": "text",
    "shipmentMethodTypeId": "text",
    "partyId": "text",
    "roleTypeId": "text",
    "companyPartyId": "text",
    "minWeight": 1,
    "maxWeight": 1,
    "minSize": 1,
    "maxSize": 1,
    "minTotal": 1,
    "maxTotal": 1,
    "allowUspsAddr": "text",
    "requireUspsAddr": "text",
    "allowCompanyAddr": "text",
    "requireCompanyAddr": "text",
    "includeNoChargeItems": "text",
    "includeFeatureGroup": "text",
    "excludeFeatureGroup": "text",
    "includeGeoId": "text",
    "excludeGeoId": "text",
    "serviceName": "text",
    "configProps": "text",
    "shipmentCustomMethodId": "text",
    "shipmentGatewayConfigId": "text",
    "sequenceNumber": 1,
    "allowancePercent": 1,
    "minimumPrice": 1,
    "fromDate": "2025-07-11T17:10:12.279Z",
    "thruDate": "2025-07-11T17:10:12.279Z",
    "isShippingWeightRequired": "text",
    "isTrackingRequired": "text",
    "description": "text",
    "parentTypeId": "text"
  }
]

list ProductStoreAndFacilityGroup

get
Authorizations
Path parameters
productStoreIdstringRequired
Query parameters
pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

facilityGroupIdstringOptional
fromDatestring · date-timeOptional
thruDatestring · date-timeOptional
sequenceNumbernumber · int64Optional
facilityGroupTypeIdstringOptional
primaryParentGroupIdstringOptional
facilityGroupNamestringOptional
descriptionstringOptional
Responses
200
Success
application/json
get
GET /rest/s1/order-routing/productStores/{productStoreId}/facilityGroups HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*
[
  {
    "_entity": "co.hotwax.facility.ProductStoreAndFacilityGroup",
    "productStoreId": "text",
    "facilityGroupId": "text",
    "fromDate": "2025-07-11T17:10:12.279Z",
    "thruDate": "2025-07-11T17:10:12.279Z",
    "sequenceNumber": 1,
    "facilityGroupTypeId": "text",
    "primaryParentGroupId": "text",
    "facilityGroupName": "text",
    "description": "text"
  }
]

Was this helpful?