Create Order

Options

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "amount", "createdAt", "id", "products", "status", "updatedAt" ],
  "type" : "object",
  "properties" : {
    "id" : {
      "type" : "string",
      "description" : "Unique ID of the order.",
      "example" : "14"
    },
    "createdAt" : {
      "type" : "string",
      "description" : "Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when order is actually created.",
      "example" : "2021-07-29T20:59:23.383Z"
    },
    "updatedAt" : {
      "type" : "string",
      "description" : "Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the status of the order is actually changed/updated.",
      "example" : "2021-07-30T10:59:23.383Z"
    },
    "status" : {
      "type" : "string",
      "description" : "State of the order.",
      "example" : "completed"
    },
    "amount" : {
      "type" : "number",
      "description" : "Total amount of the order, including all shipping expenses, tax and the price of items.",
      "example" : 308.42
    },
    "storeId" : {
      "type" : "string",
      "description" : "ID of store where the order is placed",
      "example" : "ST-21"
    },
    "products" : {
      "type" : "array",
      "items" : {
        "required" : [ "price", "productId", "quantity" ],
        "type" : "object",
        "properties" : {
          "productId" : {
            "type" : "string",
            "description" : "ID of the product.",
            "example" : "P1"
          },
          "quantity" : {
            "type" : "number",
            "description" : "How many pieces of the product the visitor has added to the cart.",
            "example" : 10
          },
          "variantId" : {
            "type" : "string",
            "description" : "Product ID of the red color shirts.",
            "example" : "P100"
          },
          "price" : {
            "type" : "number",
            "description" : "The price of a unit of product",
            "example" : 99.99
          }
        },
        "description" : "Details for the Products in an order."
      }
    },
    "email" : {
      "type" : "string",
      "description" : "Email of the contact, Mandatory if \"phone\" field is not passed in \"billing\" parameter.",
      "example" : "example@brevo.com"
    },
    "billing" : {
      "type" : "object",
      "properties" : {
        "address" : {
          "type" : "string",
          "description" : "Full billing address.",
          "example" : "15 Somewhere Road, Brynmenyn"
        },
        "city" : {
          "type" : "string",
          "description" : "Exact city of the address.",
          "example" : "Basel"
        },
        "countryCode" : {
          "type" : "string",
          "description" : "Billing country 2-letter ISO code.",
          "example" : "CA"
        },
        "country" : {
          "type" : "string",
          "description" : "Billing country name.",
          "example" : "Canada"
        },
        "phone" : {
          "type" : "string",
          "description" : "Phone number to contact for further details about the order, Mandatory if \"email\" field is not passed.",
          "example" : "01559 032133"
        },
        "postCode" : {
          "type" : "string",
          "description" : "Postcode for delivery and billing.",
          "example" : "4052"
        },
        "paymentMethod" : {
          "type" : "string",
          "description" : "How the visitor will pay for the item(s), e.g. paypal, check, etc.",
          "example" : "PayPal"
        },
        "region" : {
          "type" : "string",
          "description" : "Exact region (state/province) for delivery and billing.",
          "example" : "Northwestern Switzerland"
        }
      },
      "description" : "Billing details of an order."
    },
    "coupons" : {
      "type" : "array",
      "description" : "Coupons applied to the order. Stored case insensitive.",
      "example" : [ "EASTER15OFF" ],
      "items" : {
        "type" : "string"
      }
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers