Jump to

• Request
• Response

getShippingRegion

get

/ccadmin/v1/shippingRegions/{id}

Get Shipping Region. Returns a Shipping Region against the ID passed.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The ID of the shipping region to be fetched.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getShippingRegion_response

Type: object

Show Source

• repositoryId(optional): string
  The Repository Id of the Shipping Region.
• shippingCountryRegion(optional): array shippingCountryRegion
  The list of all regions of a country in the Shipping region.
• shippingRegionName(optional): string
  Name of the Shipping Region.

{
    "properties":{
        "repositoryId":{
            "description":"The Repository Id of the Shipping Region.",
            "type":"string"
        },
        "shippingRegionName":{
            "description":"Name of the Shipping Region.",
            "type":"string"
        },
        "shippingCountryRegion":{
            "description":"The list of all regions of a country in the Shipping region.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "country":{
                        "description":"The details of the country present in the Shipping Region.",
                        "type":"object",
                        "properties":{
                            "countryCode":{
                                "description":"The code of the country in the Shipping Region.",
                                "type":"string"
                            },
                            "displayName":{
                                "description":"The name of the country.",
                                "type":"string"
                            },
                            "repositoryId":{
                                "description":"The repository Id of country.",
                                "type":"string"
                            }
                        }
                    },
                    "regions":{
                        "description":"The list of all Shipping Regions.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "regionCode":{
                                    "description":"The code of the specific Region.",
                                    "type":"string"
                                },
                                "displayName":{
                                    "description":"The name of the specific region.",
                                    "type":"string"
                                },
                                "repositoryId":{
                                    "description":"The Repository Id of the specific region.",
                                    "type":"string"
                                },
                                "abbreviation":{
                                    "description":"The region code in abbreviated form. Usually a 2 letter country code",
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "repositoryId":{
                        "description":"Repository Id of shipping Country Region.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : shippingCountryRegion

Type: array

The list of all regions of a country in the Shipping region.

Show Source

• Array of: object items

{
    "description":"The list of all regions of a country in the Shipping region.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "country":{
                "description":"The details of the country present in the Shipping Region.",
                "type":"object",
                "properties":{
                    "countryCode":{
                        "description":"The code of the country in the Shipping Region.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The name of the country.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The repository Id of country.",
                        "type":"string"
                    }
                }
            },
            "regions":{
                "description":"The list of all Shipping Regions.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "regionCode":{
                            "description":"The code of the specific Region.",
                            "type":"string"
                        },
                        "displayName":{
                            "description":"The name of the specific region.",
                            "type":"string"
                        },
                        "repositoryId":{
                            "description":"The Repository Id of the specific region.",
                            "type":"string"
                        },
                        "abbreviation":{
                            "description":"The region code in abbreviated form. Usually a 2 letter country code",
                            "type":"string"
                        }
                    }
                }
            },
            "repositoryId":{
                "description":"Repository Id of shipping Country Region.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• country(optional): object country
  The details of the country present in the Shipping Region.
• regions(optional): array regions
  The list of all Shipping Regions.
• repositoryId(optional): string
  Repository Id of shipping Country Region.

{
    "type":"object",
    "properties":{
        "country":{
            "description":"The details of the country present in the Shipping Region.",
            "type":"object",
            "properties":{
                "countryCode":{
                    "description":"The code of the country in the Shipping Region.",
                    "type":"string"
                },
                "displayName":{
                    "description":"The name of the country.",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"The repository Id of country.",
                    "type":"string"
                }
            }
        },
        "regions":{
            "description":"The list of all Shipping Regions.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "regionCode":{
                        "description":"The code of the specific Region.",
                        "type":"string"
                    },
                    "displayName":{
                        "description":"The name of the specific region.",
                        "type":"string"
                    },
                    "repositoryId":{
                        "description":"The Repository Id of the specific region.",
                        "type":"string"
                    },
                    "abbreviation":{
                        "description":"The region code in abbreviated form. Usually a 2 letter country code",
                        "type":"string"
                    }
                }
            }
        },
        "repositoryId":{
            "description":"Repository Id of shipping Country Region.",
            "type":"string"
        }
    }
}

Nested Schema : country

Type: object

The details of the country present in the Shipping Region.

Show Source

• countryCode(optional): string
  The code of the country in the Shipping Region.
• displayName(optional): string
  The name of the country.
• repositoryId(optional): string
  The repository Id of country.

{
    "description":"The details of the country present in the Shipping Region.",
    "type":"object",
    "properties":{
        "countryCode":{
            "description":"The code of the country in the Shipping Region.",
            "type":"string"
        },
        "displayName":{
            "description":"The name of the country.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The repository Id of country.",
            "type":"string"
        }
    }
}

Nested Schema : regions

Type: array

The list of all Shipping Regions.

Show Source

• Array of: object items

{
    "description":"The list of all Shipping Regions.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "regionCode":{
                "description":"The code of the specific Region.",
                "type":"string"
            },
            "displayName":{
                "description":"The name of the specific region.",
                "type":"string"
            },
            "repositoryId":{
                "description":"The Repository Id of the specific region.",
                "type":"string"
            },
            "abbreviation":{
                "description":"The region code in abbreviated form. Usually a 2 letter country code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• abbreviation(optional): string
  The region code in abbreviated form. Usually a 2 letter country code
• displayName(optional): string
  The name of the specific region.
• regionCode(optional): string
  The code of the specific Region.
• repositoryId(optional): string
  The Repository Id of the specific region.

{
    "type":"object",
    "properties":{
        "regionCode":{
            "description":"The code of the specific Region.",
            "type":"string"
        },
        "displayName":{
            "description":"The name of the specific region.",
            "type":"string"
        },
        "repositoryId":{
            "description":"The Repository Id of the specific region.",
            "type":"string"
        },
        "abbreviation":{
            "description":"The region code in abbreviated form. Usually a 2 letter country code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "repositoryId":"100001",
    "shippingRegionName":"United States",
    "shippingCountryRegion":[
        {
            "country":{
                "countryCode":"US",
                "displayName":"United States",
                "repositoryId":"US"
            },
            "regions":[
                {
                    "regionCode":"US-AR",
                    "displayName":"Arkansas",
                    "repositoryId":"US-AR",
                    "abbreviation":"AR"
                },
                {
                    "regionCode":"US-ME",
                    "displayName":"Maine",
                    "repositoryId":"US-ME",
                    "abbreviation":"ME"
                },
                {
                    "regionCode":"US-WV",
                    "displayName":"West Virginia",
                    "repositoryId":"US-WV",
                    "abbreviation":"WV"
                },
                {
                    "regionCode":"US-GA",
                    "displayName":"Georgia",
                    "repositoryId":"US-GA",
                    "abbreviation":"GA"
                },
                {
                    "regionCode":"US-OR",
                    "displayName":"Oregon",
                    "repositoryId":"US-OR",
                    "abbreviation":"OR"
                }
            ],
            "repositoryId":"100001"
        }
    ]
}

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| |------------------|------------------| |80012|Invalid shipping region details.| |80016|Error getting a shipping region.| |80020|Shipping region does not exist for id: {0}.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top