KIBO OMS DOCUMENTATION

Create Order Authorize

The Create Order Authorize API will reach out to the payment gateway that Kibo OMS is integrated with and create an authorization token for the payment information. That token will then need to be passed through the Create Order request as the “Authorization ID” parameter. Therefore, this call should be made before Create Order or other processing APIs.

Note that this call does not support split orders, as the payment token is associated 1:1 with an Order ID. When an order is split, each of the resulting orders must have a separate authorization request.

The .json address above can be used to access the schema within Postman. An example use of the Create Order Authorize API follows below, or view the schema or the sample Postman Collection.

Example

The example case creates an API call to authorize a payment that has the following properties:

• External Cart ID 0123456
• USD Credit Card payment

This guide will demonstrate how to put together each section of the request to build this order.

Required Parameters

These parameters are necessary for the Create Order API to return a successful response:

Optional Parameters

There are a few other optional parameters that can be included if needed:

Customer

These are the possible parameters available to create the Customer object. Only firstName, lastName, email, and phone1 are required.

This example demonstrates the Customer object that will be used in the authorize request.

"customer": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "John.Smith@kibocommerce.com",
    "password": null,
    "phone1": "4691111111",
    "active": null,
    "accountCreated": null
  },

Payment Method

The Payment Method must be one of eleven options. This example only shows how to use one option (a standard credit card payment), so see the schema for descriptions of the other ten possibilities such as gift cards, PayPal, and so forth.

"paymentMethod": {
  "billingAddress": {
    "firstName": "John",
    "lastName": "Smith",
    "addressLine1": "111 Example St",
    "phone": "4691111111",
    "city": "San Luis Obispo",
    "state": "CA",
    "postalCode": "93401",
    "countryCode": "US",
    "latitude": null,
    "longitude": null,
    "company": null
  },
  "paymentType": "CC",
  "cardIssuer": "VI",
  "noOperationType": null,
  "cardNumber": "4111111111111111",
  "cardExpiration": "10-2019",
  "cardSecurityCode": "123",
  "payPalToken": null,
  "payPalPayerID": null,
  "paymentMethodToken": null,
  "authToken": null,
  "ccLastFour": null,
  "cardToken": null,
  "creditPlan": null,
  "creditPlanType": null,
  "retailerRef": null,
  "financeCode": null,
  "paymentMethodID": null
},

The Full Request

This is the entire request that will authorize order creation.

{
  "externalCartID": "0123456",
  "manufacturerID": 01010,
  "catalogID": 0,
  "currency": "USD",
  "locale": "en-US",
  "customer": {
    "firstName": "John",
    "lastName": "Smith",
    "email": "John.Smith@kibocommerce.com",
    "password": null,
    "phone1": "4691111111",
    "active": null,
    "accountCreated": null
  },
  "paymentMethod": {
    "billingAddress": {
      "firstName": "John",
      "lastName": "Smith",
      "addressLine1": "111 Example St",
      "phone": "4691111111",
      "city": "San Luis Obispo",
      "state": "CA",
      "postalCode": "93401",
      "countryCode": "US",
      "latitude": null,
      "longitude": null,
      "company": null
    },
    "paymentType": "CC",
    "cardIssuer": "VI",
    "noOperationType": null,
    "cardNumber": "4111111111111111",
    "cardExpiration": "10-2019",
    "cardSecurityCode": "123",
    "payPalToken": null,
    "payPalPayerID": null,
    "paymentMethodToken": null,
    "authToken": null,
    "ccLastFour": null,
    "cardToken": null,
    "creditPlan": null,
    "creditPlanType": null,
    "retailerRef": null,
    "financeCode": null,
    "paymentMethodID": null
  },
  "amount": 2.00,
  "testOrder": true,
  "shippingAddress": {
    "addressID": null,
    "customerID": null,
    "firstName": "Alan",
    "lastName": "Gudiel",
    "addressLine1": "222 Test Example Dr",
    "phone": "97200000000",
    "city": "Petaluma",
    "state": "CA",
    "postalCode": "94954",
    "countryCode": "US",
    "fraudLock": null,
    "active": null,
    "latitude": null,
    "longitude": null,
    "company": null,
    "taxID": null,
    "isBilling": null,
    "isShipping": null
  }
}

The response will return the Order ID, Payment Method Token, and Auth Token. The authorization token is what should be used in the Create Order request.