[order-manager] Order-Manager Controller API

[tonykang22]

Order-Manager Controller API

구입 중인 상품 목록 조회

• Zinc API로 구입을 신청한 상품들의 목록을 확인할 수 있다.
  • n 개의 상품에 대해 소요되는 시간 : 8 ~ 8 * n 분
• Order-manager의 병목 구간이라 할 수 있기 때문에 추후 실제 운영 시 확인이 필요할 것으로 생각된다.

Request

GET /v1/order-manager/purchasing-products

Response

• Response example (json)

  {
  "status": "SUCCESS",
  "body": {
      "size": "2",
      "content": [
          {
              "requestId": "12345",
              "orderManagerProduct": {
                  "coupangSoldProduct": null,
                  "amazonProduct": null,
                  "zincResponseDto": null,
                  "ohmyzipResponseDto": null
              }
          },
          {
              "requestId": "2345",
              "orderManagerProduct": {
                  "coupangSoldProduct": null,
                  "amazonProduct": null,
                  "zincResponseDto": null,
                  "ohmyzipResponseDto": null
              }
          }
      ]
  }
  }

구입이 비정상적으로 멈춘 상품 목록 조회

• 다양한 에러로 인해, 해당 작업부터 다시 진행되어야하는 상품의 목록을 호출한다.
• 어떠한 단계에서부터 에러가 있었는지, 얼마나 있는지 확인할 수 있기에 유용한 정보가 될 것으로 생각된다.

Request

GET /v1/order-manager/unfinished-products

Response

• Response example (json)

  {
  "status": "SUCCESS",
  "body": {
      "queue_size": "3",
      "content": [
          {
              "requestId": "123",
              "jobStatus": "PURCHASE",
              "responseDto": {
                  "coupangSoldProduct": null,
                  "amazonProduct": null,
                  "zincResponseDto": null,
                  "ohmyzipResponseDto": null
              }
          },
          {
              "requestId": "abc",
              "jobStatus": "DELIVERY",
              "responseDto": {
                  "coupangSoldProduct": null,
                  "amazonProduct": null,
                  "zincResponseDto": null,
                  "ohmyzipResponseDto": null
              }
          },
          {
              "requestId": "456",
              "jobStatus": "PREPARE",
              "responseDto": {
                  "coupangSoldProduct": null,
                  "amazonProduct": null,
                  "zincResponseDto": null,
                  "ohmyzipResponseDto": null
              }
          }
      ]
  }
  }

스케쥴 작업 중지 및 재개

• 필요에 의해 스케쥴 작업을 중지 혹은 재개할 수 있어야 한다.
  • 예) 아마존 잔액 부족

Request

PUT /v1/order-manager/schedule-status

• Required attributes

Attribute	Type	Description
status	String	Whether to stop or start the scheduled tasks.

Response

• Response example (json)

  {
  "status": "SUCCESS",
  "body": "Request sent successfully."
  }