Jump to

• Request
• Response

Create an extension

post

/ccadmin/v1/extensions

Note:This endpoint is intended for extensions that have just been uploaded and never previously activiated. It validates and processes a previously uploaded extension file. The file must have been uploaded previously using the /ccadmin/v1/files endpoint.

An ExtensionID must also have be created before uploading the extension and copied into the extension manifest file.

See Create an Extension for more information on extensions.

Sample Request:

       POST /ccadmin/v1/extensions    

Request

Supported Media Types

• application/json

Body ()

Root Schema : createExtension_request

Type: object

Show Source

• name: string
  The name of the previously uploaded extension.

{
    "properties":{
        "name":{
            "description":"The name of the previously uploaded extension.",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "example":"POST /ccadmin/v1/extensions"
}

Example:

POST /ccadmin/v1/extensions

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returned when the operation succeeds.

Body ()

Root Schema : createExtension_response

Type: object

Show Source

• errors(optional): string
  An array of strings containing explanations of the errors that caused the server to not accept the extension.
• success(optional): boolean
  True if the extension was successfully processed.
• warnings(optional): string
  An array of strings. You can get warnings even if the extension was successfully processed.

{
    "properties":{
        "success":{
            "description":"True if the extension was successfully processed.",
            "type":"boolean"
        },
        "warnings":{
            "description":"An array of strings. You can get warnings even if the extension was successfully processed.",
            "type":"string"
        },
        "errors":{
            "description":"An array of strings containing explanations of the errors that caused the server to not accept the extension.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "success":true,
    "warnings":[
    ],
    "error":[
    ]
}

400 Response

Returned when the extension contains an error.

Body ()

Root Schema : createExtension_400response

Type: object

Show Source

• errorCode(optional): string
  The error code
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The error code",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "message":"HTTP 400 Bad Request",
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4",
    "status":"400"
}

401 Response

Returned if the user is not authenticated

Body ()

Root Schema : createExtension_401response

Type: object

Show Source

• errorCode(optional): string
  The error code
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The error code",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"00001000",
    "message":"The user is not authenticated",
    "status":"401"
}

404 Response

Returned if the source extension is not found.

Body ()

Root Schema : createExtension_404response

Type: object

Show Source

• errorCode(optional): string
  The error code
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The error code",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "message":"HTTP 404 not found",
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4",
    "status":"404"
}

500 Response

Returned if an internal error occurs in the endpoint.

Body ()

Root Schema : createExtension_500response

Type: object

Show Source

• errorCode(optional): string
  The Commerce error code. See the table below for information on common codes.
• message(optional): string
  The localized message describing the error
• status(optional): string
  HTTP status code

{
    "properties":{
        "errorCode":{
            "description":"The Commerce error code. See the table below for information on common codes.",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "status":{
            "description":"HTTP status code",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "errorCode":"000000000",
    "message":"Internal Error",
    "status":"500"
}

Default Response

The following internal error codes are thrown by this API when the request fails in Commerce:

Error Code	Description	Possible Fix
91004	Extension internal error	See error messages for further information.
20307	File not found	Ensure that the extension file has been uploaded.

The error response:

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