/
partner_order_payload.yaml
65 lines (51 loc) · 2.44 KB
/
partner_order_payload.yaml
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
required: true
content:
application/json:
schema:
type: object
properties:
partner_order:
required: true
type: object
description: Object which represents the order to be placed.
properties:
oem_token:
$ref: '/swagger/components/requestBodies/fields.yaml#/oem_token'
purchased_at:
$ref: '/swagger/components/requestBodies/fields.yaml#/purchased_at'
email:
$ref: '/swagger/components/requestBodies/fields.yaml#/email'
partner_order_items:
required: true
type: array
description: List of all order items.
items:
$ref: '/swagger/components/requestBodies/partner_order_item_payload.yaml'
description: |-
Payload to create an OEM partner order on SCC API.
The request's payload *must* contain a JSON object that *should* correspond to
a single order.
At the root of the main JSON object, there *must* be an unique key named
`"partner_order"`, whose value *should* be an JSON object representing an OEM
partner order, containing the following keys:
- `"oem_token"`: string, **required**
Value *must* be a string, with a maximum length of 255 characters.
It *should not* be empty, and must be unique per OEM partner at the moment
of placing a new order. It is generated and kept by the OEM partner.
- `"purchased_at"`: string, **required**
Value *must* be a string, ISO8601-formatted. It must be older than the
current date and time (cannot be a moment in the future). It represents
the date and time at which the customer placed the order with the OEM
partner.
- `"email"`: string, *optional*
Value *must* be a string, email-formatted. The key-value pair *may* be
ommited. It represents the customer's email address to be notified aboutt
activated subscriptions.
- `"partner_order_items"`: array of JSON objects, **required**
Value *must* be an array of JSON objects representing the order items.
Those objects *should* contain the following keys:
- `"sku"`: string, **required**
Value *must* be a string and *must* match a valid SUSE SKU.
- `"system_limit"`: integer, **required**
Value *must* be an integer greater than one. It represents the maximum
number of systems which can use the given SKU simultaneously.