Create Location

​

Headers

  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

  • Content-Type
    enum
    const:  
    application/json
    required

    Request payload format. Must be application/json when a body is sent.

Body·

required
application/json
  • account_id
    Type: string
    required
  • address
    Type: nullable
    required

    Address for a create request. Supplied state, ZIP and country values must be valid. For a US address, use a two-letter state and a five-digit ZIP or ZIP+4. Country defaults to USA when omitted or null. Blank or omitted address details are accepted where the endpoint permits an incomplete address.

    Properties: 6
  • name
    Type: string
    required
  • country_code
    Type: stringnullable
  • currency
    Type: stringnullable
  • email
    Type: stringnullable
  • metadata
    Type: Metadatanullable
    Properties: 1
  • phone
    Type: stringnullable
  • processor_config_id
    Type: stringnullable
  • status
    Type: string
  • surcharge_basis
    Type: enumnullable

    Amount used to calculate percentage-based surcharges. total uses subtotal, tax and tip; subtotal uses subtotal only; subtotal_plus_tax includes tax; subtotal_plus_tip includes tip. The basis is resolved from location, then terminal, then account, skipping null values. The default is total when no level configures a basis.

    values
    totalsubtotalsubtotal_plus_taxsubtotal_plus_tip
  • surcharge_confirmation_required
    Type: booleannullable

Responses

  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v1/locations
curl https://api.uat.koard.com/v1/locations \
  --request POST \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN' \
  --data '{
  "name": "",
  "account_id": "",
  "address": {
    "street_line1": "",
    "street_line2": "",
    "city": "",
    "country": "",
    "state": "",
    "zip": ""
  },
  "phone": "",
  "email": "",
  "status": "active",
  "processor_config_id": "",
  "country_code": "USA",
  "currency": "USD",
  "terminal_id": "",
  "metadata": {
    "additionalProperty": "anything"
  },
  "surcharge_rate": 1,
  "surcharge_confirmation_required": true,
  "surcharge_basis": "total",
  "tax_rate": 1,
  "tax_basis": "total"
}'

{
  "account_id": "string",
  "address": {
    "street_line1": "",
    "street_line2": "",
    "city": "",
    "country": "USA",
    "state": "",
    "zip": ""
  },
  "country_code": null,
  "created_at": null,
  "currency": null,
  "deleted_at": null,
  "email": null,
  "id": "string",
  "metadata": null,
  "name": "string",
  "phone": null,
  "processor_config_id": null,
  "status": "active",
  "surcharge_rate": null,
  "surcharge_basis": "total",
  "surcharge_confirmation_required": null,
  "tax_rate": null,
  "tax_basis": "total",
  "terminal_id": null,
  "updated_at": null
}

Successful Response