platform/developer

Use the Developer resource to view and update information and files related to application packages.

JSON Example

Application Properties

Property Description
applicationType

type: string

The type of application, which is "Capability" or "Extension."

auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

devPackages

type: list of package

The package that includes the application.

package.applicationId

type: int

The unique identifier of the application. The application ID is one part of the application key.

package.assetFileCount

type: int

Integer that represents the number of files in the application package.

package.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

package.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

package.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

package.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

package.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

package.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

package.isLocked

type: bool

Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked.

package.isReleasePackage

type: bool

If true, this application package is a release candidate. If false, this application version package is a development package.

package.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

package.userId

type: string

Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string.

id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

releasePackage

type: package

The release package that includes the application.

package.applicationId

type: int

The unique identifier of the application. The application ID is one part of the application key.

package.assetFileCount

type: int

Integer that represents the number of files in the application package.

package.auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

package.auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

package.auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

package.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

package.auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

package.id

type: int

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

package.isLocked

type: bool

Indicates if a customer account and associated data is locked. If true, the user account is locked due to multiple failed authentication attempts. The user cannot login until the account is unlocked.

package.isReleasePackage

type: bool

If true, this application package is a release candidate. If false, this application version package is a development package.

package.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

package.userId

type: string

Unique identifier of the customer account (shopper or system user). System-supplied and read-only. If the shopper user is anonymous, the user ID represents a system-generated user ID string.

Operations

Operation Name Request URI Description
DeletePackageFile DELETE packages%2f%7bapplicationKey%7d%2ffiles%2f%7b*filepath%7d

Deletes the specified file from the specified application package.

GetAppPackageNames GET applications%2f%7bapplicationKey%7d%2fpackagenames%3fresponseFields%3d%7bresponseFields%7d

Returns a collection of package names for the application specified in the request.

GetAppVersions GET applications%2fversions%2f%7bnsAndAppId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the available versions for the application specified in the request.

GetPackageFileMetadata GET packages%2f%7bapplicationKey%7d%2ffilemetadata%2f%7b*filepath%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the metadata for a file in an application package.

GetPackageMetadata GET packages%2f%7bapplicationKey%7d%2fmetadata%3fresponseFields%3d%7bresponseFields%7d

Retrieves the metadata for a folder in an application package.

RenamePackageFile POST packages%2f%7bapplicationKey%7d%2ffiles_rename%3fresponseFields%3d%7bresponseFields%7d

Renames a file in an application package.

UpsertPackageFile POST packages%2f%7bapplicationKey%7d%2ffiles%2f%7b*filepath%7d%3flastModifiedTime%3d%7blastModifiedTime%7d%26responseFields%3d%7bresponseFields%7d

Insert or update the specified file into the specified application package.