Draft Orders API (ranked 52 of 5138)https://escape-data-and-specs.s3.fr-par.scw.cloud/specs/Draft_Orders_API_b30ac9d3_7609_4164_a28c_9583ffc46572_json.json
Draft Orders API
This API is about operations you can perform on the draft order object as defind below:
||The id of the order associated to the draft order, once created.||
||Name of the draft order, format #D<number>, where number, is an sequential identifier unique to the shop, starting at 1. For example #D133||
||Customer object will be serialized with only the default address, however only the ID can be set in order to associate the customer to the draft order. Setting the value to null removes the customer from the draft order.||
||The mailing address to where the draft order will be shipped.||
||The mailing address associated with the payment method.||
||The text of an optional note that a shop owner can attach to|
The security score of an API is computed as the number of OWASP top 10 vulnerabilities detected in the API.
- OWASP issues detected: API7:2023
The performance score is derived from the median response time of the API, sometimes referred as p50. The median is the value separating the higher half from the lower half of a data sample, here the response times of the API.
- The median response time of the API is 171 ms .
Get p50 under 220 ms to get a 4/5 score.
The reliability score is derived from the number of inconsistent server responses, either server errors or non-conforming return values.
- Self compliance: response objects matched the declared response types.
- Server errors: the server did not return any 5xx error.
The design score reflects the quality of the specification file (usually named openapi.json or swagger.json). Having a high-quality specification file (with up-to-date types and examples) help developers understand the API and tools produce relevant documentation.
- Respects OpenAPI 2.0 schema specification.
- Contains comments and summaries.
- Contains examples.
- Does not contain duplicated objects.
The popularity score is computed from the number of references to the API found on the internet. Have your API used by many developers to get a higher score!