Skip to main content

Create Order​

This API helps you to create a new order.

Query Parameters
  • cartId required

    The unique id of the cart.

Request Body required
  • orderType string required

    Possible values: [delivery, pickup]

    Type of the order.

  • orderStatus string

    Possible values: [pending, complete]

    Status of the order.

  • billingAddressId string required

    ID of the Billing Address.

  • shippingAddressId string

    ID of the Shipping Address.

  • scheduledAt string

    The date at which the order was scheduled.

  • payments object[] required
  • paymentMethodId number required

    Unique identifier of the Payment method used.

  • amount number required

    Amount paid in the respective payment.

  • status string required

    Possible values: [pending, complete, refunded]

    Status of payment.

Responses

Success response

{
  "statusCode": 201,
  "data": {
    "storeId": 1171,
    "locationId": 1364,
    "userId": "63775bf2622952337246312a",
    "type": "pickup",
    "status": "complete",
    "items": [
      {
        "variation": {
          "_id": 352183,
          "name": "Tomato Basil Penne Pasta"
        },
        "item": {
          "_id": 343468,
          "name": "Penne Pasta"
        },
        "category": {
          "_id": 34259,
          "name": "Pasta"
        },
        "inventoryId": 363731,
        "name": "Tomato Basil Penne Pasta",
        "image": "https://s3.amazonaws.com/posbytz-qa/items/0a5c76d2-934e-42d7-83ab-77a9d8c78fe4-large.jpg",
        "sku": "777785553444070",
        "quantity": 1,
        "price": 180,
        "mrp": 0,
        "groups": [],
        "subtotal": 180,
        "tax": 0,
        "taxes": [],
        "discount": 0,
        "discounts": [],
        "total": 180,
        "_id": "63f0d29551f4efba724cd733"
      }
    ],
    "bill": {
      "subtotal": 180,
      "tax": 0,
      "taxes": [],
      "discount": 0,
      "discounts": [],
      "charge": 0,
      "charges": [],
      "roundOff": 0,
      "total": 180
    },
    "payments": [
      {
        "paymentMethodId": 18,
        "name": "Cash On Delivery",
        "slug": "cod",
        "amount": 180,
        "status": "complete"
      }
    ],
    "billingAddress": {
      "annotation": "Home",
      "line": "Plot No 52, Balarishna Nagar, 1st Street, Thiruninravur",
      "area": "Thiruninravur",
      "city": "Chennai",
      "state": "Tamil Nadu",
      "country": "India",
      "zip": "602024",
      "landmark": "Near Kamban Park",
      "coordinates": [
        0,
        0
      ],
      "default": false,
      "_id": "63526083733e9dc27c656f89"
    },
    "createdAt": "2023-02-18T13:30:21.105Z",
    "_id": "63f0d2ed51f4efba724cd79c",
    "user": {
      "_id": "63775bf2622952337246312a",
      "email": {
        "id": "harish@bytize.in",
        "verified": true
      },
      "mobile": {
        "code": "+91",
        "number": "9962794005",
        "verified": true
      },
      "dob": "Mon Jul 05 1993 05:30:00 GMT+0530 (India Standard Time)",
      "gender": "Male",
      "name": "Harish Mohan"
    }
  }
}