1nce/collections/1nce-order-management.opencollection.json at main · api-evangelist/1nce · GitHub

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
{
  "opencollection": "1.0.0",
  "info": {
    "name": "Order Management",
    "version": "v2.0"
  },
  "items": [
    {
      "info": {
        "name": "Orders",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get All Orders",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.1nce.com/management-api/v1/orders",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Number index of the requested order list page.  Use this parameter to iterate through all orders on the different pages. The total amount of pages is listed in the response header."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Defines the size of a page, the number of individual orders listed on one page. The maximum allowed value is 10."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Sort the order list by specific keys (order_number, order_status and/or order_date) in a comma seperated list. The default is order_number if no paramter is given."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get a complete list of all 1NCE orders for the given account."
        },
        {
          "info": {
            "name": "Create Order",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.1nce.com/management-api/v1/orders",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Trigger an order using a POST request."
        },
        {
          "info": {
            "name": "Get Single Order",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.1nce.com/management-api/v1/orders/:order_number",
            "params": [
              {
                "name": "order_number",
                "value": "1234",
                "type": "path",
                "description": "Order number identifying one specific order."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Get a single Order, identified by its order_number."
        }
      ]
    }
  ],
  "bundled": true
}