m2-customer-code-store/swagger.json at main · NYPL/m2-customer-code-store · 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
{
  "swagger": "2.0",
  "info": {
    "version": "0.1",
    "title": "M2 Customer Code By Barcode API",
    "description": "returns M2 Customer Codes for given item barcodes"
  },
  "basePath": "/api",
  "schemes": [
    "https"
  ],
  "tags": [
    {
      "name": "m2",
      "description": "M2 customer code API"
    }
  ],
  "definitions": {
    "M2CustomerCodeByBarcodeResponseSuccess": {
      "description": "Successful operation",
      "properties": {
         "data": {
          "type": "array",
          "example": [
            {
              "barcode": "33433122885894",
              "m2CustomerCode": "JS"
            },
            [
              {
                "barcode": "33433122885895",
                "m2CustomerCode": "JK"
              }
            ]
          ]
         }
      }},
    "M2CustomerCodeByBarcodeResponseFailure": {
      "description": "Failure due to no barcodes or all unmatched barcodes provided",
      "properties": {
        "message": {
          "type": "string",
          "example": "Customer codes not found for barcodes: 334"
        }
      }
    }
  },
  "paths": {
    "/v0.1/m2-customer-codes": {
      "get": {
        "tags": [
          "m2"
        ],
        "summary": "Get m2 customer codes by item barcode",
        "description": "Get m2 customer codes by item barcode",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "barcodes",
            "in": "query",
            "description": "comma delineated list of barcodes",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/M2CustomerCodeByBarcodeResponseSuccess"
            }
          },
          "400": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/M2CustomerCodeByBarcodeResponseFailure"
            }
          }
        },
        "security": [
          {
            "api_auth": [
              "openid"
            ]
          }
        ]
      }
    }
  }
}