Create Order

Creates a new order

SecurityMarketplace Api Key | Merchant Secret Token | Marketplace JWT | Merchant JWT

Request

header Parameters

Merchant-Id

string

Perform operation in the context of the given merchant. Usually not required — specify only if acting on behalf of a merchant not implied by the credentials specified in the Authorization header.

Request Body schema: application/json
required

One of:

required

object (CreateOnlineOrder1)

Represents an order processed in real-time, typically on an e-commerce site.

Responses

200

400

401

403

404

405

406

409

422

429

500

503

post/orders

Request samples

Payload
Curl
JavaScript

application/json

{"CreateOnlineOrder": {"referenceOrderId": "ORD-12411",
"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"customerEmailAddress": "lucy.diamond@star.com",
"customerPhoneNumber": "string",
"description": "string",
"items": [{"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"description": "string",
"sku": "string",
"quantity": 0,
"imageUrl": "string"
}
],
"discountAmount": 0,
"shipping": {"amount": 0,
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"carrier": "string",
"name": "string",
"phoneNumber": "string",
"trackingNumber": "string"
},
"billing": {"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"name": "string",
"phoneNumber": "string"
},
"metadata": { }
}
}

Response samples

application/json

{"OnlineOrder": {"order": {"orderId": "ordr_ZuETEfcchRTAmuBI",
"merchantId": "mcht_ZuETEfcchRTAmuBE",
"referenceOrderId": "ORD-12411",
"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"surcharge": {"surchargeOptions": {"property1": "string",
"property2": "string"
},
"surchargePaidAmount": 0
},
"customerEmailAddress": "string",
"customerPhoneNumber": "string",
"customerName": "string",
"orderType": "online",
"orderTypeDetails": {"InvoiceOrderTypeDetails": {"invoiceLineItems": [{"feeAmount": 0,
"taxAmount": 0,
"totalTransactionValue": 0,
"count": 0,
"description": "string",
"category": "string",
"unitPrice": "string"
}
],
"customerConfig": {"merchantPublicKey": "string",
"customToken": "string",
"hidePayLaterOption": true,
"billingPaymentSourceId": "psrc_ZuETEfcchRTAmuBK"
}
}
},
"description": "string",
"items": [{"amount": {"minorCurrencyUnits": 0,
"currency": "AUD"
},
"description": "string",
"sku": "string",
"quantity": 0,
"imageUrl": "string"
}
],
"discountAmount": 0,
"shipping": {"amount": 0,
"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"carrier": "string",
"name": "string",
"phoneNumber": "string",
"trackingNumber": "string"
},
"billing": {"address": {"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postalCode": "string",
"country": "string"
},
"name": "string",
"phoneNumber": "string"
},
"metadata": { },
"status": "created",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
}
}

Create Order

header Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required