API_Order - Laterality/yummy-dishes-REST GitHub Wiki

Index

주문 등록

주문을 등록합니다.

  • URL

    /order/register

  • Method:

    POST

  • URL Params

    none

  • Data Params

    Body

    date_to_receive
    date
    수령 희망 일자
    orderer
    string
    주문자의 "_id" 필드값
    phone_number
    string
    휴대폰 번호, 기본값은 주문자의 휴대폰 번호
    additional
    string
    요청사항

  • Success Response:

    • Code: 201
      Content:

      { 
	"result": "ok",
	"order": {
		...
	}
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지
      order
      OrderModel
      요청이 성공한 경우 생성된 주문 정보

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
	"result": "fail",
	"message": "not found(user)"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    {
    "date_to_receive": "2017-09-23",
    "orderer": "...",
    "additional": "some additional content of order",
}

  • Notes:

    • 주문이 생성되면 사용자의 장바구니는 자동으로 비워집니다.

주문 조회

단일 주문을 조회합니다.

  • URL

    /order/{orderId}

  • Method:

    GET

  • URL Params

    REQUIRED:

    orderId
    string
    조회할 주문의 "_id" 필드값
    q
    string
    조회할 필드명(,로 구분)
    ["date_ordered", "date_to_receive", "date_received", "orderer", "products", "phone_number", "state", "additional", "price_total"]

  • Data Params

    none

  • Success Response:

    • Code: 200
      Content:

      { 
	"result": "ok",
	"order": {
		...
	}
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지
      order
      OrderModel
      조회된 주문 정보

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
	"result": "fail",
	"message": "not found(order)"
}

    OR

    • Code: 405 INVALID PARAMETER Content: 
      {
	"result": "fail",
	"message": "invalid parameter"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    GET /order/59c616906e104f08a8e4a7df

  • Notes:

    None


사용자 별 주문 조회

특정 사용자의 주문 내역을 조회합니다.

  • URL

    /user/{userId}/orders

  • Method:

    GET

  • URL Params

    REQUIRED:

    userId
    string
    조회할 사용자의 "_id" 필드값
    q
    string
    조회할 필드명(,로 구분)
    ["date_ordered", "date_to_receive", "date_received", "orderer", "products", "phone_number", "state", "additional", "price_total"]

  • Data Params

    none

  • Success Response:

    • Code: 200
      Content:

      { 
	"result": "ok",
	"orders": [{
			...
		},
		{
			...
		},
		...
	]
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지
      orders
      Array<OrderModel>
      조회된 주문 정보

  • Error Response:

    • Code: 404 NOT FOUND
      Content: 
      {
	"result": "fail",
	"message": "not found(user)"
}

    OR

    • Code: 405 INVALID PARAMETER Content: 
      {
	"result": "fail",
	"message": "invalid parameter"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    GET /user/59c616906e104f08a8e4a7df/orders

  • Notes:

    None


주문 갱신

주문을 갱신합니다.

  • URL

    /{orderId}/update

  • Method:

    PUT

  • URL Params

    Required:

    orderId
    string
    카테고리의 "_id" 필드

  • Data Params

    Body

    state
    string
    업데이트할 상태
    ["pending", "processing", "receiving", "received", "rejected", "cancelled"]

  • Success Response:

    • Code: 200
      Content:

      { 
	"result": "ok"
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지

  • Error Response:

    • Code: 404 NOT FOUND Content: 
      {
	"result": "fail",
	"message": "not found(order)"
}

    OR

    • Code: 405 INVALID PARAMETERS Content: 
      {
	"result": "fail",
	"message": "invalid parameters"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    {
  "state": "processing"
}

  • Notes:

    • 주문 상태는 다음과 같습니다
      pending(대기중) -> processing(주문 처리중) -> receiving(제품 수령 대기중) -> received(제품 수령됨)
      `-> rejected(주문 거부)
      `-> cancelled(주문 취소)

주문 제거

카테고리를 제거하는 API입니다.

  • URL

    /{orderId}/delete

  • Method:

    DELETE

  • URL Params

    Required:

    orderId
    string
    주문의 "_id" 필드

  • Data Params

    none

  • Success Response:

    • Code: 200
      Content:

      { 
	"result": "ok"
}
      result
      string
      요청에 대한 처리 결과["ok", "fail", "error"]
      message
      string
      처리 결과에 대한 추가 메시지

  • Error Response:

    • Code: 404 NOT FOUND Content: 
      {
	"result": "fail",
	"message": "not found"
}

    OR

    • Code: 405 INVALID PARAMETERS Content: 
      {
	"result": "fail",
	"message": "invalid parameters"
}

    OR

    • Code: 500 SERVER FAULT
      Content: 
      {
	"result": "error",
	"message": "server fault"
}

  • Sample Call:

    DELETE /order/599a5eb80abb413e0a7abff4/delete

  • Notes:

    none


⚠️ **GitHub.com Fallback** ⚠️