quicklanch-server/src/app/modules/order/order.swagger.ts

export const orderSwaggerDocs = {
  "/api/order": {
    post: {
      tags: ["order"],
      summary: "Create  new order",
      description: ` INITIATED
    CONFIRMED
    ONGOING
    DELIVERED
    CANCELLED`,
      requestBody: {
        required: true,
        content: {
          "application/json": {
            example: JSON.stringify({
              shopAccountId: "",
              productPrice: 1500,
              productQuantity: 2,
              productName: "Wireless Mouse",
              customerName: "Rahim Uddin",
              customerPhone: "+8801712345678",
              customerEmail: "softvence.abumahid@gmail.com",
              customerAddress: "Rangpur, Bangladesh",
              customerNote: "Please deliver between 3-5 PM",
            }),
          },
        },
      },
      responses: {
        201: { description: "order created successfully" },
        500: { description: "Validation error or internal server error" },
      },
    },
    get: {
      tags: ["order"],
      summary: "Get all order",
      description: "",
      parameters: [
        {
          name: "page",
          in: "query",
          required: false,
          schema: { type: "number" },
        },
        {
          name: "limit",
          in: "query",
          required: false,
          schema: { type: "number" },
        },
        {
          name: "search",
          in: "query",
          required: false,
          schema: { type: "string" },
        },
        {
          name: "customerName",
          in: "query",
          required: false,
          schema: { type: "string" },
        },
        {
          name: "productName",
          in: "query",
          required: false,
          schema: { type: "string" },
        },
        {
          name: "status",
          in: "query",
          required: false,
          schema: { type: "string" },
        },
        {
          name: "date",
          in: "query",
          required: false,
          schema: { type: "string" },
        },
        {
          name: "startDate",
          in: "query",
          required: false,
          schema: { type: "string", format: "date" },
          example: "2026-04-01",
        },
        {
          name: "endDate",
          in: "query",
          required: false,
          schema: { type: "string", format: "date" },
          example: "2026-04-31",
        },
      ],
      responses: {
        200: { description: "order fetched successfully" },
        401: { description: "unauthorized" },
      },
    },
  },

  "/api/order/{id}": {
    get: {
      tags: ["order"],
      summary: "Get single order",
      description: "",
      parameters: [
        {
          name: "id",
          in: "path",
          required: true,
          schema: { type: "string" },
        },
      ],
      responses: {
        200: { description: "order fetched successfully" },
        401: { description: "unauthorized" },
      },
    },
    patch: {
      tags: ["order"],
      summary: "Update order -(Admin route)",
      description: "",
      parameters: [
        {
          name: "id",
          in: "path",
          required: true,
          schema: { type: "string" },
        },
      ],
      requestBody: {
        required: true,
        content: {
          "application/json": {
            example: JSON.stringify({
              status: "INITIATED",
            }), // put your request body
          },
        },
      },
      responses: {
        200: { description: "order updated successfully" },
        500: { description: "Validation error or internal server error" },
      },
    },
    delete: {
      tags: ["order"],
      summary: "Delete order",
      description: "",
      parameters: [
        {
          name: "id",
          in: "path",
          required: true,
          schema: { type: "string" },
        },
      ],
      responses: {
        200: { description: "order delete successfully" },
        401: { description: "unauthorized" },
      },
    },
  },
};