go-prestashop-api

A PrestaShop API Golang Wrapper for the Prestashop Webservice API

Install

$ go get github.com/dinistavares/go-prestashop-api

Usage

Create a new API client and authenticate with your Webservice key. You should specify the URL protocol by prefixing your domain name with https:// or http://. Follow the Prestashop documentation to enable the webservice through the Prestashop user interface or programmatically then create your API keys through the Prestashop user interface or programmatically.

Authenticate

import (
  "github.com/dinistavares/go-prestashop-api"
)

func main(){
  shopURL := "https://example.com"
  key := "xxxxxxx"

  client, err := prestashop.New(shopURL)

  if err != nil {
    // handle error

    return
  }

  client.Authenticate(key)
}

Resources

The API routes are broken down into services, the supported services are:

Carts (Create, Get, List, ListCartsByCustomerID)
Customers (Create, Get, GetCustomersByEmail, List)
Orders (Create, Get, List, ListOrdersByCustomerID)
Products (Create, Get, List)

Get Customer by ID with all fields.

func (client *prestashop.Client) listOrders() {
  customer, _, err := client.Customer.Get(2, nil)

  if err != nil {
    // Handle errors

    return
  }


  // ....
}

Get Customer by ID with specified fields.

func (client *prestashop.Client) listOrders() {
  params := &prestashop.ServiceListParams{
    // Results should only show firstname & email
    Display: &prestashop.ServiceListDisplay{
      "firstname",
      "email"
    },
  }

  customer, _, err := client.Customer.Get(2, params)

  if err != nil {
    // Handle errors

    return
  }


  // ....
}

List customer with firstname 'bob'.

func (client *prestashop.Client) listOrders() {
  params := &prestashop.ServiceListParams{
    // Results should only show customer id, firstname & email
    Display: &prestashop.ServiceListDisplay{
      "id",
      "firstname",
      "email"
    },
    // Filter customers with firstname as 'bob'
    Filter: &prestashop.ServiceListFilter{
      Key: "firstname",
      Values: []string{"bob"},
      Operator: prestashop.ListFilterOperatorLiteral,
    },
  }

  customer, _, err := client.Customer.List(params)

  if err != nil {
    // Handle errors

    return
  }


  // ....
}

XML Support

func (client *prestashop.Client) listOrders() {
  params := &prestashop.ServiceListParams{
    Display: &prestashop.ServiceListDisplay{
      "id",
      "name",
      "price",
    },
  }

  product, _, err := client.Product.Get(1, params)

  if err != nil {
    // Handle error

    return
  }

  if product != nil {
    productXML, _ := xml.Marshal(*product)
    fmt.Print(string(productXML))
  } else {
    // Hanlde no product found
  }


  // ....
}

Result:

<Product>
    <id>1</id>
    <price>23.900000</price>
    <name>
        <language id="1" href="https://crisp-plugin-dinis.ngrok.io/api/languages/1">Hummingbird printed t-shirt</language>
        <language id="2" href="https://crisp-plugin-dinis.ngrok.io/api/languages/3">تيشيرت بطبعة الطائر الطنان</language>
    </name>
</Product>

JSON Support

func (client *prestashop.Client) listOrders() {
  params := &prestashop.ServiceListParams{
    Display: &prestashop.ServiceListDisplay{
      "id",
      "name",
      "price",
    },
  }

  product, _, err := client.Product.Get(1, params)

  if err != nil {
    // Handle error

    return
  }

  if product != nil {
    productJSON, _ := json.Marshal(*product)
    fmt.Print(string(productJSON))
  } else {
    // Hanlde no product found
  }


  // ....
}