Jump to

• Request
• Response

updateDefaultPriceListGroup

put

/ccadmin/v1/merchant/defaultPriceListGroup

Update Default Price List Group. Update the default PriceListGroup only if this price list group is present in available price list groups associated with site.

Request

Supported Media Types

• application/json

Body ()

Root Schema : updateDefaultPriceListGroup_request

Type: object

Show Source

• id: string
  ID of the PriceListGroup that we wish to make the default PriceListGroup. This ID should be present in available price list groups associated with site.

{
    "properties":{
        "id":{
            "description":"ID of the PriceListGroup that we wish to make the default PriceListGroup. This ID should be present in available price list groups associated with site.",
            "type":"string"
        }
    },
    "required":[
        "id"
    ],
    "example":{
        "id":"CanadianDollar"
    }
}

Example:

{
    "id":"CanadianDollar"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateDefaultPriceListGroup_response

Type: object

Show Source

• repositoryId(optional): string
  The ID of the PriceListGroup, which is the current default PriceListGroup

{
    "properties":{
        "repositoryId":{
            "description":"The ID of the PriceListGroup, which is the current default PriceListGroup",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "displayName":"Canadian Dollar",
    "repositoryId":"CanadianDollar",
    "listPriceList":{
        "repositoryId":"CanadianDollar_listPrice"
    },
    "active":false,
    "salePriceList":{
        "repositoryId":"CanadianDollar_salePrice"
    },
    "currency":{
        "symbol":"$",
        "displayName":"US Dollar",
        "repositoryId":"en_US",
        "fractionalDigits":2,
        "currencyCode":"USD",
        "numericCode":"840"
    },
    "id":"CanadianDollar",
    "basePriceListGroup":{
        "displayName":"US Dollar",
        "id":"usDollar"
    },
    "locale":"en_US",
    "shippingSurchargePriceList":{
        "repositoryId":"CanadianDollar_shippingSurchargePrice"
    }
}

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| |------------------|------------------| |20214|Inactive PriceListGroup can not be set as the default.| |30003|Could not update site : siteUS| |20187|No PriceListGroup found for the id : invalidId| |20184|Missing required property: id| |20208|PriceListGroup ID should be present in the list available price list groups associated with site.|

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