OFN API Handbook
  • Welcome!
  • Quick Start
  • OFN API V1
    • Overview
    • Authentication
    • Customers
  • OFN API V0 - unsupported
    • Overview
    • Reports
    • Products
  • N8N - integrations server
    • Introduction
    • How to import/use a workflow from a file or API handbook
    • Authenticating Apps
    • Email a Stock Report
  • Adding Customer List to Airtable
  • Adding Product List to Airtable
  • Tips, Tricks, and Common Issues
  • Postgres Database
  • Creating Customers (with Tags) on OFN using V1 API with data from a CSV/XLSX file
  • Common SQL Queries (on-going)
  • Global Metrics Dashboard
  • DFC - n8n experiment
  • Product List Export
  • Product List Export (OFN Product Upload CSV format)
  • Import customers contacts from OFN to newsletter
  • Invite OFN customers to subscribe to a newsletter
  • Automated Quickbooks Customer Invoicing
  • Low Stock Alert for Producers
  • Enterprise Dashboard for Customers
  • Connecting Square POS with OFN for updating stock values, sales analytics etc.
  • Webhooks
    • Overview
    • Setup
    • Event types
Powered by GitBook
On this page
  1. OFN API V1

Customers

Beta Release

PreviousAuthenticationNextOverview

Last updated 2 years ago

Index

Code Examples

https://INSTANCE_URL/api/v1/customers
https://INSTANCE_URL/api/v1/customers?enterprise_id=ENTERPRISE_ID

Show

Code Examples

Create

Code Examples

curl -X POST "INSTANCE_URL/api/v1/customers" 
     -H "X-Spree-Token: YOUR_API_KEY" 
     -H "accept: application/json"
     -d "enterprise_id: ENTERPRISE_ID"
     -d "email: EMAIL"
     -d "first_name: FIRST_NAME"
     -d "last_name: LAST_NAME"
     -d "tags: TAG_LIST" 
const myOptions = {
  url: INSTANCE_URL+'/api/v1/customers',
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Accept': 'application/json',
  },
  params: {
    'token': API_TOKEN,
  },
  body: {
    'enterprise_id': ENTERPRISE_ID,
    'email': EMAIL,
    'first_name': FIRST_NAME,
    'last_name': LAST_NAME,
    'tags': TAG_LIST
  }
}

const myRequest = new Request('customers.json', myOptions);
fetch(myRequest).then((response) => {
  // ...
});

Update

Destroy

Code Examples

List customers

get

/api/v1/customers

Query parameters
enterprise_idstring
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '//api/v1/customers'
200
{
  "data": [
    {
      "id": "1",
      "type": "customer",
      "attributes": {
        "id": 1,
        "enterprise_id": 2,
        "first_name": "Alice",
        "last_name": "Springs",
        "code": "BUYER1",
        "email": "alice@example.com",
        "allow_charges": false,
        "tags": [
          "staff",
          "discount"
        ],
        "terms_and_conditions_accepted_at": "2022-03-12T15:55:00.000+11:00",
        "billing_address": null,
        "shipping_address": {
          "phone": "0404 333 222 111",
          "latitude": -37.8173751,
          "longitude": 144.964803195704,
          "first_name": "Alice",
          "last_name": "Springs",
          "street_address_1": "1 Flinders Street",
          "street_address_2": "",
          "postal_code": "1234",
          "locality": "Melbourne",
          "region": {
            "code": "Vic",
            "name": "Victoria"
          },
          "country": {
            "code": "AU",
            "name": "Australia"
          }
        }
      },
      "relationships": {
        "enterprise": {
          "data": {
            "id": "text",
            "type": "enterprise"
          },
          "links": {
            "related": "text"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "results": 250,
      "pages": 5,
      "page": 2,
      "per_page": 50
    }
  },
  "links": {
    "self": "text",
    "first": "text",
    "prev": "text",
    "next": "text",
    "last": "text"
  }
}

Customers list

Show customer

get

/api/v1/customers/{id}

Path parameters
idstringrequired
Responses
application/json
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url '//api/v1/customers/{id}'
200
401
404
{
  "data": {
    "id": "1",
    "type": "customer",
    "attributes": {
      "id": 1,
      "enterprise_id": 2,
      "first_name": "Alice",
      "last_name": "Springs",
      "code": "BUYER1",
      "email": "alice@example.com",
      "allow_charges": false,
      "tags": [
        "staff",
        "discount"
      ],
      "terms_and_conditions_accepted_at": "2022-03-12T15:55:00.000+11:00",
      "billing_address": null,
      "shipping_address": {
        "phone": "0404 333 222 111",
        "latitude": -37.8173751,
        "longitude": 144.964803195704,
        "first_name": "Alice",
        "last_name": "Springs",
        "street_address_1": "1 Flinders Street",
        "street_address_2": "",
        "postal_code": "1234",
        "locality": "Melbourne",
        "region": {
          "code": "Vic",
          "name": "Victoria"
        },
        "country": {
          "code": "AU",
          "name": "Australia"
        }
      }
    },
    "relationships": {
      "enterprise": {
        "data": {
          "id": "text",
          "type": "enterprise"
        },
        "links": {
          "related": "text"
        }
      }
    }
  },
  "meta": {},
  "links": {}
}

Customer

Create customer

post

/api/v1/customers

Body
enterprise_idintegerrequired
Example: 2
first_namestring | nullable
Example: Alice
last_namestring | nullable
Example: Springs
codestring | nullable
Example: BUYER1
emailstringrequired
Example: alice@example.com
tagsstring[]
Example: ["staff","discount"]
billing_addressobject | nullable
shipping_addressobject | nullable
Example: {"phone":"0404 333 222 111","latitude":-37.8173751,"longitude":144.964803195704,"first_name":"Alice","last_name":"Springs","street_address_1":"1 Flinders Street","street_address_2":"","postal_code":"1234","locality":"Melbourne","region":{"code":"Vic","name":"Victoria"},"country":{"code":"AU","name":"Australia"}}
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request POST \
  --url '//api/v1/customers' \
  --header 'Content-Type: application/json' \
  --data '{
    "enterprise_id": 2,
    "first_name": "Alice",
    "last_name": "Springs",
    "code": "BUYER1",
    "email": "alice@example.com",
    "tags": [
      "staff",
      "discount"
    ],
    "billing_address": null,
    "shipping_address": {
      "phone": "0404 333 222 111",
      "latitude": -37.8173751,
      "longitude": 144.964803195704,
      "first_name": "Alice",
      "last_name": "Springs",
      "street_address_1": "1 Flinders Street",
      "street_address_2": "",
      "postal_code": "1234",
      "locality": "Melbourne",
      "region": {
        "code": "Vic",
        "name": "Victoria"
      },
      "country": {
        "code": "AU",
        "name": "Australia"
      }
    }
  }'
201
422
{
  "data": {
    "id": "1",
    "type": "customer",
    "attributes": {
      "id": 1,
      "enterprise_id": 2,
      "first_name": "Alice",
      "last_name": "Springs",
      "code": "BUYER1",
      "email": "alice@example.com",
      "allow_charges": false,
      "tags": [
        "staff",
        "discount"
      ],
      "terms_and_conditions_accepted_at": "2022-03-12T15:55:00.000+11:00",
      "billing_address": null,
      "shipping_address": {
        "phone": "0404 333 222 111",
        "latitude": -37.8173751,
        "longitude": 144.964803195704,
        "first_name": "Alice",
        "last_name": "Springs",
        "street_address_1": "1 Flinders Street",
        "street_address_2": "",
        "postal_code": "1234",
        "locality": "Melbourne",
        "region": {
          "code": "Vic",
          "name": "Victoria"
        },
        "country": {
          "code": "AU",
          "name": "Australia"
        }
      }
    },
    "relationships": {
      "enterprise": {
        "data": {
          "id": "text",
          "type": "enterprise"
        },
        "links": {
          "related": "text"
        }
      }
    }
  },
  "meta": {},
  "links": {}
}

Example customer created

Update customer

put

/api/v1/customers/{id}

Path parameters
idstringrequired
Body
enterprise_idintegerrequired
Example: 2
first_namestring | nullable
Example: Alice
last_namestring | nullable
Example: Springs
codestring | nullable
Example: BUYER1
emailstringrequired
Example: alice@example.com
tagsstring[]
Example: ["staff","discount"]
billing_addressobject | nullable
shipping_addressobject | nullable
Example: {"phone":"0404 333 222 111","latitude":-37.8173751,"longitude":144.964803195704,"first_name":"Alice","last_name":"Springs","street_address_1":"1 Flinders Street","street_address_2":"","postal_code":"1234","locality":"Melbourne","region":{"code":"Vic","name":"Victoria"},"country":{"code":"AU","name":"Australia"}}
Responses
application/json
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request PUT \
  --url '//api/v1/customers/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "enterprise_id": 2,
    "first_name": "Alice",
    "last_name": "Springs",
    "code": "BUYER1",
    "email": "alice@example.com",
    "tags": [
      "staff",
      "discount"
    ],
    "billing_address": null,
    "shipping_address": {
      "phone": "0404 333 222 111",
      "latitude": -37.8173751,
      "longitude": 144.964803195704,
      "first_name": "Alice",
      "last_name": "Springs",
      "street_address_1": "1 Flinders Street",
      "street_address_2": "",
      "postal_code": "1234",
      "locality": "Melbourne",
      "region": {
        "code": "Vic",
        "name": "Victoria"
      },
      "country": {
        "code": "AU",
        "name": "Australia"
      }
    }
  }'
200
422
{
  "data": {
    "id": "1",
    "type": "customer",
    "attributes": {
      "id": 1,
      "enterprise_id": 2,
      "first_name": "Alice",
      "last_name": "Springs",
      "code": "BUYER1",
      "email": "alice@example.com",
      "allow_charges": false,
      "tags": [
        "staff",
        "discount"
      ],
      "terms_and_conditions_accepted_at": "2022-03-12T15:55:00.000+11:00",
      "billing_address": null,
      "shipping_address": {
        "phone": "0404 333 222 111",
        "latitude": -37.8173751,
        "longitude": 144.964803195704,
        "first_name": "Alice",
        "last_name": "Springs",
        "street_address_1": "1 Flinders Street",
        "street_address_2": "",
        "postal_code": "1234",
        "locality": "Melbourne",
        "region": {
          "code": "Vic",
          "name": "Victoria"
        },
        "country": {
          "code": "AU",
          "name": "Australia"
        }
      }
    },
    "relationships": {
      "enterprise": {
        "data": {
          "id": "text",
          "type": "enterprise"
        },
        "links": {
          "related": "text"
        }
      }
    }
  },
  "meta": {},
  "links": {}
}

Customer updated

Delete customer

delete

/api/v1/customers/{id}

Path parameters
idstringrequired
Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url '//api/v1/customers/{id}'
200
{
  "data": {
    "id": "1",
    "type": "customer",
    "attributes": {
      "id": 1,
      "enterprise_id": 2,
      "first_name": "Alice",
      "last_name": "Springs",
      "code": "BUYER1",
      "email": "alice@example.com",
      "allow_charges": false,
      "tags": [
        "staff",
        "discount"
      ],
      "terms_and_conditions_accepted_at": "2022-03-12T15:55:00.000+11:00",
      "billing_address": null,
      "shipping_address": {
        "phone": "0404 333 222 111",
        "latitude": -37.8173751,
        "longitude": 144.964803195704,
        "first_name": "Alice",
        "last_name": "Springs",
        "street_address_1": "1 Flinders Street",
        "street_address_2": "",
        "postal_code": "1234",
        "locality": "Melbourne",
        "region": {
          "code": "Vic",
          "name": "Victoria"
        },
        "country": {
          "code": "AU",
          "name": "Australia"
        }
      }
    },
    "relationships": {
      "enterprise": {
        "data": {
          "id": "text",
          "type": "enterprise"
        },
        "links": {
          "related": "text"
        }
      }
    }
  },
  "meta": {},
  "links": {}
}

Customer deleted

  • Index
  • GETList customers
  • Show
  • GETShow customer
  • Create
  • POSTCreate customer
  • Update
  • PUTUpdate customer
  • Destroy
  • DELETEDelete customer