listShippingMethods
post
/ccagent/v1/shippingMethods
List Shipping Methods. Get a list of shipping methods that are valid for a given address.This Endpoint is clone of StoreFront endpoint and it can be used if application running on agent/admin server need access to shipping methods data configured for StoreFront.
Request
Supported Media Types
- application/json
Header Parameters
-
X-CCOrganization(optional): string
the organization Id for which the shipping methdods are required
-
x-ccsite(optional): string
the site id for which the shippping methods are required
Root Schema : listShippingMethods_request
Type:
Show Source
object-
items:
array items
The array of products in the shopping cart.
-
priceInfo(optional):
object priceInfo
The price information.
-
productIdForShippingSurcharge:
array productIdForShippingSurcharge
array of product ids present in the cart.
-
shippingAddress(optional):
object shippingAddress
shipping address of the profile
Example:
{
"priceInfo":{
"amount":22.98,
"total":22.98,
"shipping":0,
"shippingSurchargeValue":0,
"tax":0,
"subTotal":22.98,
"currencyCode":"USD",
"totalWithoutTax":22.98
},
"shippingGroups":[
{
"shippingGroupId":"sg10001",
"shippingAddress":{
"lastName":"test",
"country":"United States",
"address3":"",
"address2":"",
"city":"redwood city",
"prefix":"",
"address1":"ste100",
"defaultCountryCode":null,
"postalCode":"94085",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"firstName":"sample",
"phoneNumber":"5345345",
"alias":"Address",
"faxNumber":"",
"middleName":"",
"state":"California",
"selectedState":"CA",
"email":"sample@example.com",
"state_ISOCode":"US-CA"
},
"items":[
{
"commerceItemId":"ci7000501",
"quantity":2,
"productId":"prod10004",
"childItems":[
{
"addOnItem":true,
"quantity":1,
"productId":"Product_18Cxi",
"displayName":"Dr. Dolittle",
"catRefId":"Sku_18Dxi"
}
],
"catRefId":"sku10028"
},
{
"quantity":2,
"productId":"Product_36Exy",
"catRefId":"Sku_36Fxy"
}
],
"productIdForShippingSurcharge":[
"Product_15CD"
]
},
{
"shippingGroupId":"sg10002",
"shippingAddress":{
"lastName":"test",
"country":"United States",
"address3":"",
"address2":"hjghg",
"city":"jhg",
"prefix":"",
"address1":"hgjghjg",
"defaultCountryCode":null,
"postalCode":"03031",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":false,
"suffix":"",
"selectedCountry":"US",
"firstName":"sample no tax",
"phoneNumber":"675675675",
"alias":"Address##3",
"faxNumber":"",
"middleName":"",
"state":"New Hampshire",
"selectedState":"NH",
"email":"sample@example.com",
"state_ISOCode":"US-NH"
},
"items":[
{
"commerceItemId":"ci7000501",
"quantity":2,
"productId":"prod10004",
"childItems":[
{
"addOnItem":true,
"quantity":1,
"productId":"Product_18Cxi",
"displayName":"Dr. Dolittle",
"catRefId":"Sku_18Dxi"
}
],
"catRefId":"sku10028"
},
{
"quantity":2,
"productId":"Product_36Exy",
"catRefId":"Sku_36Fxy"
}
],
"productIdForShippingSurcharge":[
"Product_15CD"
]
}
],
"shoppingCart":{
"coupons":[
],
"items":[
{
"commerceItemId":"ci7000501",
"quantity":4,
"productId":"prod10004",
"childItems":[
{
"addOnItem":true,
"quantity":2,
"productId":"Product_18Cxi",
"displayName":"Dr. Dolittle",
"catRefId":"Sku_18Dxi"
}
],
"catRefId":"sku10028"
},
{
"quantity":4,
"productId":"Product_36Exy",
"catRefId":"Sku_36Fxy"
}
]
}
}Nested Schema : priceInfo
Type:
objectThe price information.
Show Source
-
amount(optional):
number
The total order amount.
-
currencyCode(optional):
string
The currency code.
-
shipping(optional):
number
The total shipping cost.
-
shippingSurchargeValue(optional):
number
Extra handling costs for shipping the products.
-
subTotal(optional):
number
Sub-total.
-
tax(optional):
number
The total tax amount.
-
total(optional):
number
The order total.
Nested Schema : productIdForShippingSurcharge
Type:
arrayarray of product ids present in the cart.
Show Source
Nested Schema : shippingAddress
Type:
objectshipping address of the profile
Show Source
-
address1:
string
the address1 of the shipping address
-
address2(optional):
string
the address2 of the shipping address
-
city:
string
the city of the shipping address
-
country:
string
the country of the shipping address
-
county(optional):
string
the county of the shipping address
-
email:
string
the email address
-
firstName:
string
the first name of the shipping address
-
lastName:
string
the last name of the shipping address
-
phoneNumber(optional):
string
the phone Number of the shipping address
-
postalCode:
string
the postal Code of the shipping address
-
selectedCountry(optional):
string
the country code of the shipping address
-
selectedState(optional):
string
the state ISO alpha-2 code of the shipping address
-
state(optional):
string
the state of the shipping address
-
state_ISOCode(optional):
string
the state ISO alpha-4 code of the shipping address
Nested Schema : items
Type:
Show Source
object-
catRefId:
string
The category to which the product belongs.
-
currentPrice:
integer
The current price of the item.
-
discountInfo(optional):
object discountInfo
Discount information.
-
price(optional):
string
The Price.
-
productId:
string
ID of the product in the cart.
-
quantity:
integer
The quantity of the product in the cart.
-
stockStatus:
string
The stock status of the product.
Nested Schema : discountInfo
Type:
objectDiscount information.
Show Source
-
coupon:
string
Coupon code.
-
promotionDesc:
string
Promotion description.
-
promotionId:
string
Pomotion ID.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listShippingMethods_response
Type:
Show Source
object-
items(optional):
array items
The list of shipping methods.
Nested Schema : items
Type:
Show Source
object-
associatedPriceListGroups(optional):
array associatedPriceListGroups
The associated Price list groups for this Shipping Method.
-
displayName(optional):
string
The display name for the shipping method given the current locale.
-
displaySequence(optional):
integer
Used to determine the ordering of shipping methods in the UI. Lower values should appear first in any ordered list.
-
eligibleForProductWithSurcharges(optional):
boolean
Whether this shipping method is enabled for products with surcharges or not. Defaults to false.
-
enabled(optional):
boolean
Whether this shipping method is enabled or not.
-
externalId(optional):
string
External Id for the shipping method
-
internalName(optional):
string
Internal name for the shipping method.
-
isExternallyPriced(optional):
boolean
Whether this shipping method can be priced externally or not. Defaults to false.
-
isFallback(optional):
boolean
Use this shipping method when Commerce Cloud cannot connect to an external shipping service. Defaults to false.
-
name(optional):
string
The internal name for the shipping method.
-
ranges(optional):
array ranges
The price ranges for this shipping method.
-
repositoryId(optional):
string
The ID of the shipping method item.
-
shippingCalculator(optional):
string
A valid key for the available calculator types.
-
shippingGroupType(optional):
string
The internal name for the shipping method.
-
shipToLocations(optional):
array shipToLocations
The Shipping Regions for a Shipping Method
-
taxCode(optional):
string
A valid tax code for calculating tax on shipping.
Nested Schema : associatedPriceListGroups
Type:
arrayThe associated Price list groups for this Shipping Method.
Show Source
Nested Schema : items
Type:
Show Source
object-
active(optional):
boolean
If the price list group is active.
-
currency(optional):
object currency
The currency of the price list group.
-
deleted(optional):
boolean
If the price list deleted
-
displayName(optional):
string
The display name of the price list group.
-
id(optional):
string
The id of the price list group.
-
locale(optional):
string
The locale associated
-
repositoryId(optional):
string
The repository Id of the price list group.
Nested Schema : currency
Type:
objectThe currency of the price list group.
Show Source
-
repositoryId(optional):
string
The repository ID of the currency.
Nested Schema : items
Type:
Show Source
object-
amount(optional):
number
The monetary value for the range.
-
high(optional):
number
The upper boundary of the range.
-
low(optional):
number
The lower boundary of the range.
-
repositoryId(optional):
string
The repository id of this priceRange item.
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
The repository ID of the shipping region.
-
shippingCountryRegion(optional):
array shippingCountryRegion
The shipping country region
-
shippingRegionName(optional):
string
The name of the Shipping Region
Nested Schema : items
Type:
Show Source
object-
country(optional):
object country
The shipping country.
-
regions(optional):
array regions
The regions in the shipping country
-
repositoryId(optional):
string
The repository ID of the shipping country region.
Nested Schema : country
Type:
objectThe shipping country.
Show Source
-
repositoryId(optional):
string
The repository ID of the country.
Nested Schema : items
Type:
Show Source
object-
repositoryId(optional):
string
The repository ID of the region.
Example Response (application/json)
[
{
"items":[
{
"shippingGroupId":"sg960413",
"shippingAddress":{
"lastName":"sample",
"country":"US",
"city":"City01",
"prefix":"",
"postalCode":"94085",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":true,
"suffix":"",
"selectedCountry":"US",
"populateShippingMethods":false,
"alias":"Address",
"state":"CA",
"selectedState":"CA",
"email":"sample@example.com",
"state_ISOCode":"US-CA",
"address3":"",
"address2":"Address2",
"address1":"11 Address Line",
"defaultCountryCode":null,
"firstName":"sample",
"phoneNumber":"5345345",
"faxNumber":"",
"middleName":""
},
"items":[
{
"commerceItemId":"ci7000501",
"quantity":2,
"productId":"Product_15CD",
"childItems":[
{
"addOnItem":true,
"quantity":1,
"productId":"Product_18Cxi",
"displayName":"Dr. Dolittle",
"catRefId":"Sku_18Dxi"
}
],
"catRefId":"Sku_15DE"
},
{
"quantity":2,
"productId":"Product_36Exy",
"catRefId":"Sku_36Fxy"
}
],
"shippingMethods":[
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":25,
"high":99.99,
"low":0,
"repositoryId":"standardRange_01"
},
{
"amount":35,
"high":null,
"low":100,
"repositoryId":"standardRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Standard",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":0,
"repositoryId":"standardShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"standardShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":25,
"high":99.99,
"low":0,
"repositoryId":"priorityRange_01"
},
{
"amount":35,
"high":null,
"low":100,
"repositoryId":"priorityRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Priority",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":4,
"repositoryId":"priorityShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"priorityShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":0,
"high":null,
"low":0,
"repositoryId":"freeRange_01"
}
],
"associatedPriceListGroups":[
],
"displayName":"Free Shipping",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":5,
"repositoryId":"freeShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"freeShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":25,
"high":99.99,
"low":0,
"repositoryId":"twoDayRange_01"
},
{
"amount":35,
"high":null,
"low":100,
"repositoryId":"twoDayRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Two Day",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":6,
"repositoryId":"twoDayShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"twoDayShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":4.5,
"high":49.99,
"low":0,
"repositoryId":"groundRange_01"
},
{
"amount":8.5,
"high":99.99,
"low":50,
"repositoryId":"groundRange_02"
},
{
"amount":11,
"high":null,
"low":100,
"repositoryId":"groundRange_03"
}
],
"associatedPriceListGroups":[
],
"displayName":"Ground",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":7,
"repositoryId":"groundShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"groundShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":35,
"high":99.99,
"low":0,
"repositoryId":"overNightRange_01"
},
{
"amount":45,
"high":null,
"low":100,
"repositoryId":"overNightRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Overnight",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":"FR020400",
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":9,
"repositoryId":"overNightShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"overNightShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"external",
"eligibleForProductWithSurcharges":true,
"estimatedDeliveryDateGuaranteed":false,
"isExternallyPriced":false,
"internationalDutiesTaxesFees":0,
"ranges":[
{
"amount":14.95,
"high":1.7976931348623157E308,
"low":0
}
],
"displayName":"canadapost-overnight",
"taxCode":"GT987",
"shippingGroupType":"hardgoodShippingGroup",
"estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
"enabled":true,
"deliveryDays":2,
"repositoryId":"canadapost-overnight",
"isFallback":false,
"carrierId":"ON"
},
{
"shippingCalculator":"external",
"estimatedDeliveryDateGuaranteed":false,
"isExternallyPriced":false,
"internationalDutiesTaxesFees":0,
"ranges":[
{
"amount":33,
"high":1.7976931348623157E308,
"low":0
}
],
"displayName":"fedex-2dayground",
"taxCode":"TD543",
"shippingGroupType":"hardgoodShippingGroup",
"estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
"enabled":true,
"deliveryDays":2,
"repositoryId":"fedex-2dayground",
"isFallback":false,
"carrierId":"1D"
}
]
},
{
"shippingGroupId":"sg960414",
"shippingAddress":{
"lastName":"sample",
"country":"US",
"city":"City2",
"prefix":"",
"postalCode":"03031",
"jobTitle":"",
"companyName":"",
"county":"",
"isDefaultAddress":false,
"suffix":"",
"selectedCountry":"US",
"populateShippingMethods":false,
"alias":"Address##3",
"state":"NH",
"selectedState":"NH",
"email":"sample@example.com",
"state_ISOCode":"US-NH",
"address3":"",
"address2":"Address2",
"address1":"22 Address1",
"defaultCountryCode":null,
"firstName":"sample no tax",
"phoneNumber":"675675675",
"faxNumber":"",
"middleName":""
},
"items":[
{
"commerceItemId":"ci7000501",
"quantity":2,
"productId":"Product_15CD",
"childItems":[
{
"addOnItem":true,
"quantity":1,
"productId":"Product_18Cxi",
"displayName":"Dr. Dolittle",
"catRefId":"Sku_18Dxi"
}
],
"catRefId":"Sku_15DE"
},
{
"quantity":2,
"productId":"Product_36Exy",
"catRefId":"Sku_36Fxy"
}
],
"shippingMethods":[
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":25,
"high":99.99,
"low":0,
"repositoryId":"standardRange_01"
},
{
"amount":35,
"high":null,
"low":100,
"repositoryId":"standardRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Standard",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":0,
"repositoryId":"standardShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"standardShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"ranges":[
{
"amount":25,
"high":99.99,
"low":0,
"repositoryId":"priorityRange_01"
},
{
"amount":35,
"high":null,
"low":100,
"repositoryId":"priorityRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Priority",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":4,
"repositoryId":"priorityShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"priorityShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"ranges":[
{
"amount":0,
"high":null,
"low":0,
"repositoryId":"freeRange_01"
}
],
"associatedPriceListGroups":[
],
"displayName":"Free Shipping",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":5,
"repositoryId":"freeShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"freeShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"ranges":[
{
"amount":25,
"high":99.99,
"low":0,
"repositoryId":"twoDayRange_01"
},
{
"amount":35,
"high":null,
"low":100,
"repositoryId":"twoDayRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Two Day",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":6,
"repositoryId":"twoDayShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"twoDayShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"ranges":[
{
"amount":4.5,
"high":49.99,
"low":0,
"repositoryId":"groundRange_01"
},
{
"amount":8.5,
"high":99.99,
"low":50,
"repositoryId":"groundRange_02"
},
{
"amount":11,
"high":null,
"low":100,
"repositoryId":"groundRange_03"
}
],
"associatedPriceListGroups":[
],
"displayName":"Ground",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":null,
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":7,
"repositoryId":"groundShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"groundShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"priceRange",
"eligibleForProductWithSurcharges":null,
"isExternallyPriced":false,
"ranges":[
{
"amount":35,
"high":99.99,
"low":0,
"repositoryId":"overNightRange_01"
},
{
"amount":45,
"high":null,
"low":100,
"repositoryId":"overNightRange_02"
}
],
"associatedPriceListGroups":[
],
"displayName":"Overnight",
"description":null,
"allSites":true,
"sites":[
],
"taxCode":"FR020400",
"type":0,
"shippingGroupType":"hardgoodShippingGroup",
"enabled":true,
"displaySequence":9,
"repositoryId":"overNightShippingMethod",
"excludedCategoriesShippingCharge":[
],
"isFallback":false,
"id":"overNightShippingMethod",
"shipToLocations":[
{
"repositoryId":"100001"
}
],
"excludedCategories":[
]
},
{
"shippingCalculator":"external",
"eligibleForProductWithSurcharges":true,
"estimatedDeliveryDateGuaranteed":false,
"internationalDutiesTaxesFees":0,
"ranges":[
{
"amount":14.95,
"high":1.7976931348623157E308,
"low":0
}
],
"displayName":"canadapost-overnight",
"taxCode":"GT987",
"shippingGroupType":"hardgoodShippingGroup",
"estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
"enabled":true,
"deliveryDays":2,
"repositoryId":"canadapost-overnight",
"carrierId":"ON"
},
{
"shippingCalculator":"external",
"estimatedDeliveryDateGuaranteed":false,
"internationalDutiesTaxesFees":0,
"ranges":[
{
"amount":33,
"high":1.7976931348623157E308,
"low":0
}
],
"deliveryDays":2,
"displayName":"fedex-2dayground",
"repositoryId":"fedex-2dayground",
"carrierId":"1D",
"taxCode":"TD543",
"shippingGroupType":"hardgoodShippingGroup",
"estimatedDeliveryDate":"2013-04-12 14:48:45 -0400",
"enabled":true
}
]
}
]
}
]Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|31004|Error in Listing Shipping Methods|
Root Schema : errorModel
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
arrayAn optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code