Jump to

• Request
• Response

getDefaultPriceListGroup

get

/ccadmin/v1/merchant/defaultPriceListGroup

Get Default Price List Group. Get default PriceListGroup

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getDefaultPriceListGroup_response

Type: object

Show Source

• active(optional): boolean
  indicates if the PriceListGroup is active
• displayName(optional): string
  display name of the PriceListGroup
• listPriceList(optional): object listPriceList
  Price List for list prices
• repositoryId(optional): string
  The ID of the PriceListGroup item
• salePriceList(optional): object salePriceList
  Price List for sale prices
• shippingSurchargePriceList(optional): object shippingSurchargePriceList
  Price List for shipping surcharge prices

{
    "properties":{
        "displayName":{
            "description":"display name of the PriceListGroup",
            "type":"string"
        },
        "repositoryId":{
            "description":"The ID of the PriceListGroup item",
            "type":"string"
        },
        "listPriceList":{
            "description":"Price List for list prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID of the list prices",
                    "type":"string"
                }
            }
        },
        "active":{
            "description":"indicates if the PriceListGroup is active",
            "type":"boolean"
        },
        "salePriceList":{
            "description":"Price List for sale prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID for the sale prices",
                    "type":"string"
                }
            }
        },
        "shippingSurchargePriceList":{
            "description":"Price List for shipping surcharge prices",
            "type":"object",
            "properties":{
                "repositoryId":{
                    "description":"Repository ID for the shipping surcharge prices",
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : listPriceList

Type: object

Price List for list prices

Show Source

• repositoryId(optional): string
  Repository ID of the list prices

{
    "description":"Price List for list prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID of the list prices",
            "type":"string"
        }
    }
}

Nested Schema : salePriceList

Type: object

Price List for sale prices

Show Source

• repositoryId(optional): string
  Repository ID for the sale prices

{
    "description":"Price List for sale prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID for the sale prices",
            "type":"string"
        }
    }
}

Nested Schema : shippingSurchargePriceList

Type: object

Price List for shipping surcharge prices

Show Source

• repositoryId(optional): string
  Repository ID for the shipping surcharge prices

{
    "description":"Price List for shipping surcharge prices",
    "type":"object",
    "properties":{
        "repositoryId":{
            "description":"Repository ID for the shipping surcharge prices",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "displayName":"UsDollar",
    "listPriceList":{
        "repositoryId":"listPrices"
    },
    "repositoryId":"UsDollar",
    "active":false,
    "salePriceList":{
        "repositoryId":"salePrices"
    },
    "currency":{
        "symbol":"$",
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "id":"UsDollar",
    "basePriceListGroup":null,
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"shippingSurchargePrices"
    }
}

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| |------------------|------------------| |80021|There was an error retrieving the selected timezone.|

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