Packages

Use this resource to initiate and manage all aspects of submitting a package to the Magento Extension Quality Program (EQP). You can provide all metadata associated with a package—both the technical and the marketing information—in a single step or in several steps using incremental updates.

• Technical information—References to code artifacts, such as Magento 1 TGZ files or Composer-compliant Magento 2 ZIP files, version compatibility, and release notes.

• Marketing information—Includes package descriptions, image assets for logos and galleries, pricing information, support and installation services offered, and various guides—user, installation, and reference in PDF.

Before submitting a package, you must first upload your files and associate the ID returned by the /rest/v1/files/uploads endpoint with your package using JSON parameters in the request body.

You can also check package submission status and retrieve reports about technical and marketing issues discovered during the EQP process.

A successful submission results in a package being published on the Magento Marketplace.

EQP review process

The EQP review process includes two steps:

• In technical review, we perform all automated testing. This step also involves manual testing after all automated tests run.
• In marketing review, we manually review all marketing content associated with your package before you can publish it on the Magento Marketplace.

These review steps occur in parallel when you submit a package. If both steps are successful, the package can be published to the Magento Marketplace. If there is a failure, you can iteratively fix issues until they are resolved.

Package fields

The following table describes all package object properties:

Both POST and PUT requests support a batch model where multiple packages can be created or updated.

Additional notes

• For required fields in a POST or PUT operation, refer to the Package submissions section.
• The EQP Kind column indicates which part of the EQP pipeline will need to use or review the field values.
• The list of valid values for license_type are:
  • afl—Academic Free License 3.0 (AFL)
  • apache—Apache License 2.0
  • bsd—BSD 2-Clause License
  • gnu-gpl—GNU General Public License 3.0 (GPL-3.0)
  • gnu-lgpl–GNU Lesser General Public License 3.0 (LGPL-3.0)
  • mit—MIT License (MIT)
  • mozilla—Mozilla Public License 1.1 (MPL-1.1)
  • osl—Open Software License 3.0 (OSL-3.0)
  • custom—Custom License

Object details

1
2
3
4
5
6
7
8
9
10
"version_compatibility" : [
  {
    "edition" : "CE",
    "versions" : [“2.0”, ”2.1”, "2.2"]
  },
  {
    "edition" : "EE",
    "versions" : [“2.0”,”2.1”, "2.2"]
  }
]

1
2
3
"artifact" : {
  "file_upload_id" : "dhsiXjdksW17623"
}

1
2
3
4
5
6
7
8
9
10
11
"documentation_artifacts" : {
  "user" : {
    "file_upload_id" : "j47dVbsFgkl"
  },
  "installation" : {
    "file_upload_id" : "d67E82hVb20"
  },
  "reference" : {
    "file_upload_id" : "9Rb5yQh7dfA"
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
“shared_packages” : [
  {
    “artifact” : {
      “file_upload_id” : “sfRh72Mx9d”
    }
  },
  {
    “artifact” : {
      “file_upload_id” : “Gh893dCxak”
    }
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
"media_artifacts" : {
  "icon_image" : {
    "file_upload_id" : "gAdh628bzXv"
  },
  "gallery_images" : [
    {
      "file_upload_id" : "hj739djXvT"
    },
    {
      "file_upload_id" : "9Dfg73482E"
    },
    {
      "file_upload_id" : "J87bdueDjxM"
    },
    {
      "file_upload_id" : "Vhke71093Z4"
    },
    {
      "file_upload_id" : "Gh8273Cx78Q"
    }
  ],
  "video_urls" : [
    "https://www.youtube.com/watch?v=l33T2-YC4tk",
    "https://www.youtube.com/watch?v=682p52tFcmY"
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
"prices" : [
  {
    "edition" : "CE",
    "currency_code" : "USD",
    "price" : 15.50
  },
  {
    "edition" : "EE",
    "currency_code" : "USD",
    "price" : 45.00,
    "installation_price" : 0.00
  }
]

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
“suppport_tiers” : [
  {
    “tier” : 1,
    “edition” : “CE”,
    "monthly_period" : 1,
    "short_description" : “<Short description goes here.>”,
    “long_description” “ “<Long description goes here.>”,
    "prices" : [
      {
        "currency_code" : "USD",
        "price" : 25.00
      }
    ]

  },
  {
    “tier” : 1,
    “edition” : “EE”,
    "monthly_period" : 1,
    "short_description" : “<Short description goes here.>”,
    “long_description” “ “<Long description goes here.>”,
    "prices" : [
      {
        "currency_code" : "USD",
        "price" : 50.00
      }
    ]

  }
]

1
2
3
4
5
6
7
8
9
10
11
12
"browser_os_compatibility" : {
  "chrome" : {
    "mac" : [ “39”, "44”],
    "windows" : [“43”, "44”],
    "linux" : [“43”, "44”]
  },
  "firefox" : {
    "mac" : [ "40”, "41”],
    "windows" : [“40”, “41”],
    "linux" : [“40”, “41”]
  }
}

1
2
3
4
5
6
7
8
9
"options" : {
  "released_with_setup_scripts"         : true,
  "included_service_contracts"          : false,
  "included_external_service_contracts" : true,
  "support_responsive_design"           : true,
  "custom_implementation_ui"            : true,
  "support_web_api"                     : true,
  "support_test_coverage"               : false
}

1
2
3
4
"action" : {
  "technical" : "submit",
  "marketing" : "submit"
}

1
2
3
“action” : {
  “overall” : “publish”
}

1
2
3
4
5
6
"eqp_status" :  {
  "overall" : "in_progress",
  "technical" : "draft",
  "marketing" : "approved"

}

Package submissions

1
2
3
4
POST /rest/v1/products/packages
PUT /rest/v1/products/packages
PUT /rest/v1/products/packages/:submission_id
PUT /rest/v1/products/packages/:item_id

Submit a package

You can submit a package in either of the following ways:

• A single POST request with all required fields set. You must explicitly indicate that you are for technical and marketing review using the action parameter.
• A series of requests, typically in the following order:
  1. A single POST request with the minimum required fields set and action set to draft in either technical, marketing, or both. This request accepts the new package and saves it on the Developer Portal for further updates. It returns a unique submission_id for subsequent PUT operations.
  2. One or more PUT requests in which you configure the package parameters. In these requests, set action to draft in technical, marketing, or both.
  3. A final PUT request indicating submission for technical, marketing, or both.

You can update one or more parameters in draft mode, but the API does not check for validation errors.

When the action field is set to publish, the API validates fields to ensure all required parameters are available on the Developer Portal to initiate the EQP process.

All action fields are optional. If not specified, draft is the default value.

The following example shows a POST request with all required parameters set for both technical and marketing submissions:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
[
  {
    "action" : {
      "technical" : "submit",
      "marketing" : "submit"
    },
    "type" : "extension",
    "platform" : "M2",
    "version_compatibility" : [
      {
        "edition" : "CE",
        "versions" : ["2.1", "2.2"]
      },
      {
        "edition" : "EE",
        "versions" : ["2.1", "2.2"]
      }
    ],
    "name" : "One Click Checkout",
    "short_description" : "<Short description here>",
    "long_description" : "<Long description here>",
    "release_notes" : "<Release notes here>",
    "artifact" : {
      "file_upload_id" : "dhsiXjdksW17623"
    },
    "documentation_artifacts" : {
      "user" : {
        "file_upload_id" : "j47dVbsFgkl"
      },
      "installation" : {
        "file_upload_id" : "d67E82hVb20"
      },
      "reference" : {
        "file_upload_id" : "9Rb5yQh7dfA"
      }
    },
    "media_artifacts" : {
      "icon_image" : {
        "file_upload_id" : "gAdh628bzXv"
      },
      "gallery_images" : [
        {
          "file_upload_id" : "hj739djXvT"
        },
        {
          "file_upload_id" : "9Dfg73482E"
        },
        {
          "file_upload_id" : "J87bdueDjxM"
        },
        {
          "file_upload_id" : "Vhke71093Z4"
        },
        {
          "file_upload_id" : "Gh8273Cx78Q"
        }
      ],
      "video_urls" : [
        "https://www.youtube.com/watch?v=l33T2-YC4tk",
        "https://www.youtube.com/watch?v=682p52tFcmY"
      ]
    },
    "categories" : [
      "//Extensions//Payments & Security//Checkout Enhancements"
    ],
    "prices" : [
      {
        "edition" : "CE",
        "currency_code" : "USD",
        "price" : 15.50
      },
      {
        "edition" : "EE",
        "currency_code" : "USD",
        "price" : 45.00,
        "installation_price" : 0.00
      }
    ],
    "license_type" : "bsd"
  }
]

Since the API accepts batch requests for both POST and PUT operations, send a single submission as an array with one item.

If you save the request body to a file, for example, /tmp/one-click-submission-1.0.0.json, the following example shows the package submission process:

Request

1
2
3
4
5
curl -X POST \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     -H 'Content-Type: application/json' \
     --data-binary  @/tmp/one-click-submission-1.0.0.json \
     https://developer-api.magento.com/rest/v1/products/packages

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
  {
    "code": 200,
    "message": "Success",
    "submission_id": "f4eacd72be",
    "eqp_status": {
      "overall": "in_progress",
      "technical": "in_automation",
      "marketing": "awaiting_marketing_review"
    },
    "created_at": "2018-04-23 16:00:00",
    "modified_at": "2018-02-23 16:00:00"
  }
]

• The API returns a HTTP 200 batch response listing items in the same order as they were provided in the request.
• Each item contains a code and message indicating success or failure. Any non-200 code indicates an error. Refer to the message for more details.
• A unique submission_id is returned for each successful item, which must be used for any GET, PUT, or DELETE methods.
• Optionally, if a user-defined item_id was supplied during the POST, the response will echo back the same item_id for each item in the batch. The resource can be retrieved via GET using the item_id.
• Any non-200 HTTP response code indicates an error for the entire batch request.

Update a package

The PUT method can be used to update packages in the following states:

• The package is in draft mode for the technical or marketing review; or both.
• The package has been rejected in either the technical or marketing review; or both. You must fix these issues and re-submit the package.
• The package has been released to the Magento Marketplace.
• The package was removed from the store by the developer and needs to be re-published.
• The package can be recalled while in the EQP pipeline.
• After a package has been released to the Magento Marketplace, you can update marketing information only. Changing marketing information causes the package to be placed in marketing review. The package continues to be live on the marketplace, and after the marketing approval, the updated fields will be published to the store.

You cannot modify a package during the EQP process, except to recall the package.

Updating several packages in a batch request is similar to the POST version above. The only difference is to supply submission_id for each item obtained from the POST request.

The PUT method also allows for updating a single package with submission_id as shown in the following example:

Request

1
2
3
4
5
curl -X PUT \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     -H 'Content-Type: application/json' \
     -d { “action” : { “overall” : “publish”} } \
     https://developer-api.magento.com/rest/v1/products/packages/f4eacd72be

The HTTP response code will indicate success or failure.

Required parameters

If the action parameter indicates submit value for technical, or marketing or both, the required parameters are listed below by their respective parallel EQP pipelines:

Technical

Marketing

Submission in several steps

As described earlier, a submission can also be done in several steps in draft mode, followed by the action to submit for technical and/or marketing review. In such cases, the first POST request in draft mode can be done with a minimal set of parameters:

With the returned submission_id, the remaining required parameters can be supplied using a PUT request in draft mode, and/or with an action to submit to either technical or marketing review; or both.

Get package details

1
2
3
4
5
6
7
8
9
GET /rest/v1/products/packages
GET /rest/v1/products/packages/:submission_id
GET /rest/v1/products/packages/skus
GET /rest/v1/products/packages/skus/:url_encoded_sku
GET /rest/v1/products/packages/items
GET /rest/v1/products/packages/items/:item_id
GET /rest/v1/products/packages/:submission_id/status
GET /rest/v1/products/packages/sku/:url_encoded_sku/status
GET /rest/v1/products/packages/item/:item_id/status

There are various ways to retrieve package details, most of which are convenient alternatives to the typical way using submission_id for a specific package submission. The data returned is the same for the primary and the secondary ways.

The alternative ways provided are:

• skus: Retrieves all versions of a particular package sku. An additional version filter is available to retrieve a specific sku and version.
• item_id: Retrieves package details by specifying a user-defined unique item_id if one was supplied during the POST call.

The following basic endpoints retrieve all package details (every version of every package submitted):

1
2
3
GET /rest/v1/products/packages
GET /rest/v1/products/packages/skus
GET /rest/v1/products/packages/items

The following status endpoints provide a detailed EQP status report of a packages:

1
2
3
GET /rest/v1/products/packages/:submission_id/status
GET /rest/v1/products/packages/sku/:url_encoded_sku/status
GET /rest/v1/products/packages/item/:item_id/status

This sample call lists all packages belonging to a user:

Request

1
2
3
curl -X GET \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     https://developer-api.magento.com/rest/v1/products/packages

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
[
  {
    "submission_id" : "f4eacd72be",
    "type" : "extension",
    "platform" : "M2",
    "version_compatibility" : [
      {
        "edition" : "CE",
        "versions" : ["2.1", "2.2"]
      },
      {
        "edition" : "EE",
        "versions" : ["2.1", "2.2"]
      }
    ],
    "name" : "One Click Checkout",
    "short_description" : "<Short description here>",
    "long_description" : "<Long description here>",
    "sku" : "acme/one-click-checkout",
    "version" : "1.1.5",
    "release_notes" : "<Release notes here>",
    "artifact" : {
      "file_upload_id" : "dhsiXjdksW17623",
      "filename" : "acme_one-click-checkout.zip",
      "content_type" : "application/zip",
      "size" : 182934,
      "malware_status" : "pass",
      "file_hash" : "f53f5db985b8815f1ce6fd4b48a0439a"
    },
    "documentation_artifacts" : {
      "user" : {
        "file_upload_id" : "j47dVbsFgkl",
        "filename" : "user.pdf",
        "content_type" : "application/pdf",
        "size" : 48392,
        "malware_status" : "pass",
        "file_hash" : "7f99e16a20457859fc0c86b5676a62ca"
      },
      "installation" : {
        "file_upload_id" : "d67E82hVb20",
        "filename" : "installation.pdf",
        "content_type" : "application/pdf",
        "size" : 34876,
        "malware_status" : "pass",
        "file_hash" : "94392b98f02c56083995d23f02e460ab"
      },
      "reference" : {
        "file_upload_id" : "9Rb5yQh7dfA",
        "filename" : "reference.pdf",
        "content_type" : "application/pdf",
        "size" : 23845,
        "malware_status" : "pass",
        "file_hash" : "ec78ded664c71d80acf0e29f5dbafe2b"
      }
    },
    "media_artifacts" : {
      "icon_image" : {
        "file_upload_id" : "gAdh628bzXv",
        "filename" : "one-click-icon.png",
        "content_type" : "image/png",
        "size" : 37492,
        "malware_status" : "pass",
        "file_hash" : "dd0d04057cd1420afb76d6afa838d394"
      },
      "gallery_images" : [
        {
          "file_upload_id" : "hj739djXvT",
          "filename" : "acme-logo.png",
          "content_type" : "image/png",
          "size" : 23947,
          "malware_status" : "pass",
          "file_hash" : "515f2eaf3cd4e43c32fda89a004306aa"
        },
        {
          "file_upload_id" : "9Dfg73482E",
          "filename" : "catalog_demo.png",
          "content_type" : "image/png",
          "size" : 37492,
          "malware_status" : "pass",
          "file_hash" : "8da78313887fdc3d2506f39c46ccde4e"
        },
        {
          "file_upload_id" : "J87bdueDjxM",
          "filename" : "cart-demo.png",
          "content_type" : "image/png",
          "size" : 38023,
          "malware_status" : "pass",
          "file_hash" : "30b6fef138e1433e6f8ff23a45b2fbb9"
        },
        {
          "file_upload_id" : "Vhke71093Z4",
          "filename" : "click-demo.png",
          "content_type" : "image/png",
          "size" : 48293,
          "malware_status" : "pass",
          "file_hash" : "0ced4d071dddc6e354acfa11f56a56f1"
        },
        {
          "file_upload_id" : "Gh8273Cx78Q",
          "filename" : "click-success.png",
          "content_type" : "image/png",
          "size" : 39482,
          "malware_status" : "pass",
          "file_hash" : "dfa3183472cc265a5510be1da0fe444c"
        }
      ],
      "video_urls" : [
        "https://www.youtube.com/watch?v=l33T2-YC4tk",
        "https://www.youtube.com/watch?v=682p52tFcmY"
      ]
    },
    "categories" : [
      "//Extensions//Payments & Security//Checkout Enhancements"
    ],
    "prices" : [
      {
        "edition" : "CE",
        "currency_code" : "USD",
        "price" : 15.50
      },
      {
        "edition" : "EE",
        "currency_code" : "USD",
        "price" : 45.00,
        "installation_price" : 0.00
      }
    ],
    "license_type" : "bsd",
    "eqp_status" :  {
      "overall" : "in_progress",
      "technical" : "rejected",
      "marketing" : "approved"
    },
    "created_time" : "2018-04-23 16:00:00",
    "modified_time" : "2018-04-23 17:53:22"
  }
]

• The previous example shows one product only, but an array of products can be returned.
• The sku and version will be determined from the code artifact (M1 tarball or M2 zip file) meta-information (M1 packages.xml or M2 composer.json), once it passes the malware checks.
• The code, documentation, and media artifact files have additional info indicating meta-information on these files, including their current malware status.
• The eqp_status field will indicate the current state of the package in the EQP process.

Get EQP status details

In the previous example, submission f4eacd72be failed. Specify the submission_id query parameter to get a more detailed report:

Request

1
2
3
curl -X GET \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     https://developer-api.magento.com/rest/v1/products/packages/f4eacd72be/status

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "code" : "fail",
  "technical" : {
    "code" : "fail",
    "results" : [
      {
        "tool" : "phpcs",
        "reports" : [
          {
            "platform" : "M2",
            "edition" : "CE",
            "version" : "2.1.12",
            "php_version" : "7.1.16",
            "status" : "pass",
            "details" : {
            }
          }
        ]
      },
      {
        "tool" : "compile",
        "reports" : [
          {
            "platform" : "M2",
            "edition" : "CE",
            "version" : "2.2.3",
            "php_version" : "7.1.16",
            "status" : "fail",
            "details" : {
              "output" : "<output bin/magento deploy:mode:set production here >"
            }
          }
        ]


      }
    ]
  },
  "marketing" : {
    "code" : "pass",
    "results" : [
    ]
  }
}

• Technical reports include the Magento edition, version, and PHP version used to run tests.
• The top-level code indicates the overall result, which can be pass, fail, or in_progress.
• Each EQP review step, technical and marketing have their own overall status indicated by the code value, which can be pass, fail or in_progress.
• The results list contains details for each tool and their respective outcome via the status field, which can be pass or fail.

Sorting and Filtering

The following fields enable both sorting and filtering support. Refer to the Package fields section above for valid values for certain fields):

A sample cURL request filtering all themes sorted by platform in ascending order and created_time in descending order:

Request

curl -X GET \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     https://developer-api.magento.com/rest/v1/products/packages?type=theme&sort=+platform,-created_time

Response

A list of theme packages can be returned in the same way as described in Get package details.

Delete a package

You can delete a package only if you specify a submission_id or item_id as a query parameter. Deleting a package is risky operation, and as a result, you cannot delete them in a batch.

1
2
DELETE /rest/v1/products/packages/:submission_id
DELETE /rest/v1/products/packages/items/:item_id

The following example deletes the package with submission_id 6fd7eaacbc:

Request

curl -X DELETE \
     -H 'Authorization: Bearer baGXoStRuR9VCDFQGZNzgNqbqu5WUwlr.cAxZJ9m22Le7' \
     https://developer-api.magento.com/rest/v1/products/packages/6fd7eaacbc

A 200 HTTP Response code indicates a successful operation.