NAV Navbar
curl
  • Introduction
  • Authentication
  • Customers
  • Customer Product Codes
  • Addresses
  • Cost Centers
  • Users
  • Inventory
  • Pricing
  • Products
  • Suppliers
  • Account Managers
  • Branches
  • Brands
  • Categories
  • Catalogs
  • Labels
  • Manufacturers
  • Orders
  • Unprocessed Orders
  • Open Quotes
  • Roles
  • Heartbeat
  • Errors
  • Introduction

    Welcome to the EvolutionX API! You can use our API to access EvolutionX API endpoints, which can get information on your store.

    You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

    Integration Guide

    The Developer Integration Guide (PDF) provides best practice information about integrating an ERP or back-office system with EvolutionX using the API. It includes example use cases and tips on working with the records and fields in key modules. It also includes a recommend minimum integration list to start guide the planning of your integration.

    Find Integration Guide Here

    Endpoint

    The API endpoint is regional, so if you have a US store, please use https://us.evoapi.io, while if you have a EU store please use https://eu.evoapi.io.

    It seems you are in the US region, please use https://us.evoapi.io.

    Special notes about updating fields

    For strings send empty strings instead of null.

    Support

    If you need help with anything regarding this API you can get in touch with our support here: api@evolution-support.com

    Throttling

    There is a limit of 100 requests allowed every 1 minute. On every response you'll get additional headers that will tell you if you reached that limit or when you are allowed to send a new request (in case you reached the limit).

    Header Description
    X-RateLimit-Limit The limit of requests you can do in 1 minute
    X-RateLimit-Remaining The number or remaining requests before reaching the limit
    Retry-After The seconds remaining when you are allowed to do more requests
    X-RateLimit-Reset The Unix timestamp in UTC that tells you when the limit resets

    Response Charset Encode

    The default charset for all responses is UTF8 encoded and we allow change it to ISO-8859-1 by sending a adicional header Accept-Charset and the respective encode type ISO-8859-1.

    Header Description
    Accept-Charset Charset encode type. At the moment we only support two values ISO-8859-1 and UTF8

    Change Log

    If you like to review any recent updates to the API please refer to our change log.

    API Change Log

    List requests and responses

    Query Parameters

    Examples

    curl "https://us.evoapi.io/list?limit=25" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    curl "https://us.evoapi.io/list?from_id=10001" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    curl "https://us.evoapi.io/list?created_at=1516693636" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    curl "https://us.evoapi.io/list?created_at[gt]=1516693636&created_at[lt]=1516693800" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    Most of the list requests will accept the following paramaters.

    Query Parameters

    Parameter Description Example
    limit The number of resources you want back. The default value is 10, the maximum value is 100. 25
    from_id The resource id from where your results should start. This paramater is used as an offset when retrieving large sets of data. 10001
    created_at This field can be a Unix timestamp in UTC from where to start retrieving your resources, or it can be a dictionary to retrieve resource in a particular daterange. This rule applies to every timestamp filter in list requests. 1516693636
        created_at[lt] Retrieve resources created before the provided Unix timestamp in UTC. 1516693636
        created_at[gt] Retrieve resources created after the provided Unix timestamp in UTC. 1516693800
    updated_at This field can be a Unix timestamp in UTC from where to start retrieving your resources, or it can be a dictionary to retrieve resource in a particular daterange. This rule applies to every timestamp filter in list requests. 1516693636
        updated_at[lt] Retrieve resources updated before the provided Unix timestamp in UTC. 1516693636
        updated_at[gt] Retrieve resources updated after the provided Unix timestamp in UTC. 1516693800

    Response Format and Pagination

    List response JSON structure

    {
        "status": "success",
        "has_more": false,
        "last_id": null,
        "data": []
    }
    

    The response of a list request will return the following attributes

    Attributes

    Attribute Description
    status The status of the response. It can be either success, warning or error. When other than success, you'll also get a message describing the error and any additional information.
    has_more Boolean, this tells you if there are more records.
    last_id It can be either null or an integer. This id identifies the last id in your request. It should be used in conjunction with has_more, to make easier your next request. This is the id that you should use (as a query parameter from_id) when getting then next batch of resources in case the has_more is true.
    data Array containing the list of resources.

    Authentication

    To authorize, use this code:

    # With shell, you can just pass the correct header with each request
    curl "https://us.evoapi.io/test" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    Make sure to replace your_secret_key with your API key.

    EvolutionX uses API keys to allow access to the API. You can request one through our customer's support.

    EvolutionX expects for the API key to be included in all API requests to the server in a header that looks like the following:

    Authorization: Bearer your_secret_key

    Along with your API key, EvolutionX expects the version to be sent on every request, in a header like the following:

    Accept: application/vnd.evolutionx.v1+json

    Customers

    The customer object

    Example Response

    {
        "id": 1000000,
        "company": "EvolutionX",
        "admin_email": "admin@company.com",
        "account_number": "EVOX001",
        "phone": "+1 23456789",
        "fax": null,
        "logo": null,
        "parent_id": "1436879",
        "enabled": true,
        "tax_number": null,
        "company_number": null,
        "duns_number": null,
        "credit_account": false,
        "seller_reference": null,
        "points_balance": 0,
        "points_pending": 0,
        "child_account_ids": [1000021, 1000045],
        "branch": {
          "id": 1,
          "name": "My Main Branch",
          "code": "MAIN",
          "email": "admin@mystore.com"
        },
        "account_manager": {
          "id": 8,
          "seller_reference": "John",
          "name": "Doe",
          "title" : "Sales Rep",
          "email": "john@example.com",
          "cell" : "+1 98765432",
          "phone" : "+1 98765432",
          "fax" : "+1 98765432",
          "comments" : "This is an account manager.",
          "image": "image.png",
          "image_path": "https://example.com/xxxxx/"
        },
        "account_manager_list": [8,33],
        "default_billing_address":{
          "id": 1000003,
          "code": "ADDR1",
          "name": "Jonh Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD"
        },
        "default_shipping_address":{
          "id": 1000003,
          "code": "ADDR1",
          "name": "Jonh Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD"
        },
        "pricing": {
          "pricing_module": true,
          "pricing_email": "mytest@email.com",
          "show_cheapest_price": false,
          "exclude_global_contract": false,
          "pricing_override_addtocart": true,
        },
        "tax": {
          "override": false,
          "override_amount": null,
          "override_shipping": false,
          "override_shipping_amount": null,
        },
        "shipping": {
          "override": false,
          "override_amount": null,
        },
        "labels": [
            {
                "id": 7,
                "name": "B2B",
                "hex": "B60205",
                "type_id": 1,
                "type": "customer",
                "enabled": true,
                "created_at": 1517844556,
                "updated_at": 1517844556
            }
        ],
        "created_at": 1516693636,
        "updated_at": 1516693636
    }
    

    Attributes

    Attribute Description
    id integer The customer id
    company string The customer company name
    admin_email string The customer admin email address. This field if not populated will inherit the email address of the first user you add to the customer.
    account_number string The customer account number. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
    phone string The customer phone
    fax string The customer fax
    logo string The customer's logo
    parent_id integer Another customer id which you would want to make the parent of this customer.
    enabled boolean True if the customer is enabled
    tax_number string The customers tax number
    company_number string The customer's number
    duns_number string The Dun and Bradstreet Number
    credit_account boolean Does this customer have a credit account
    seller_reference string The customer's seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    points_balance integer The current rewards points balance for the customer. This amount can be redeemed for reward items in the store. Orders placed in the storefront or admin (order→source = 0 are webstore orders) can accumulate points and redeem points but API (order→source = 1) and Punchout (order→source = 2) orders do not. Updating the order status will affect points balances (incuding API updates to the order status). If a webstore order (order→source = 0) is set to completed or cancelled it will apply points changes but payment status has no affect on applying points. Read more in our Rewards Help Center documents.
    points_pending integer The pending rewards points for the customer. Pending points are on orders which are not yet completed or cancelled and cannot be redeemed for reward items in the store. Read more in our Rewards Help Center documents.
    child_account_ids array An array of child account ids
    branch object An object with the branch information
      id   integer The branch id
      name   string The branch name
      code   string The branch code
      email   string The branch email
    account_manager object An object with the account manager information
      id   integer The account manager id
      seller_reference   string The account managers seller reference
      name   string The account manager name
      title   string The account manager title
      email   string The account manager email
      cell   string The account manager cell
      phone   string The account manager phone
      fax   string The account manager fax
      comments   string The account manager comments
      image   string The account manager image file name
      image_path   string The account manager image file path
    account_manager_list array An array of account managers ids
    default_billing_address object An object with billing address information. If there is no default address this will simply be null.
      id   integer The address id
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The customer name on the address
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_shipping_address object An object with shipping address information. If there is no default address this will simply be null.
      id   integer The address id
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The customer name on the address
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    pricing object An object containing data about pricing options
      pricing_module   boolean Is the live pricing module being used Note: If you are using a live pricing module the Account Number field is required.
      pricing_email   string Email used for live pricing module.
      show_cheapest_price   boolean Show the cheapest price
      exclude_global_contract   boolean Exclude the global contract
      pricing_override_addtocart   boolean Overrides the user's Add To Cart role. When true it hides the add to cart button for this customer account even if the user role enables it. This can be used to prevent ordering on a customer account.
    tax object An object containing data about tax overrides
      override   boolean Tax override
      override_amount   decimal The tax override amount
      override_shipping   boolean Override shipping amount
      override_shipping_amount   decimal The shipping tax override amount
    shipping object An object containing data about shipping overrides
      override   boolean Shipping override status
      override_amount   boolean Shipping override price
    labels array An array of label objects
      id   integer The label id
      name i  nteger The label name
      hex   string The label hex color
      type_id   integer The label type id
      type   string The label type
      enabled   boolean Is the record enabled
      created_at   timestamp The creation date (Unix timestamp in UTC).
      updated_at   timestamp The date when last updated (Unix timestamp in UTC).
    created_at timestamp The order creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the order was last updated (Unix timestamp in UTC)

    List all customers

    curl "https://us.evoapi.io/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
            {
                "id": 1000000,
                "company": "EvolutionX",
                "admin_email": "admin@company.com",
                "account_number": "EVOX001",
                "phone": "+1 23456789",
                "fax": null,
                "logo": null,
                "parent_id": "1436879",
                "enabled": true,
                "tax_number": null,
                "company_number": null,
                "duns_number": null,
                "credit_account": false,
                "seller_reference": null,
                "points_balance": 0,
                "points_pending": 0,
                "child_account_ids": [1000021, 1000045],
                "branch": {
                  "id": 1,
                  "name": "My Main Branch",
                  "code": "MAIN",
                  "email": "admin@mystore.com"
                },
                "account_manager": {
                  "id": 8,
                  "seller_reference": "John",
                  "name": "Doe",
                  "title" : "Sales Rep",
                  "email": "john@example.com",
                  "cell" : "+1 98765432",
                  "phone" : "+1 98765432",
                  "fax" : "+1 98765432",
                  "comments" : "This is an account manager.",
                  "image": "image.png",
                  "image_path": "https://example.com/xxxxx/"
                },
                "account_manager_list": [8,33],
                "default_billing_address":{
                  "id": 1000003,
                  "code": "ADDR1",
                  "name": "Jonh Doe",
                  "company": "EvolutionX",
                  "phone": "+1 98765432",
                  "line_1": "Building 3",
                  "line_2": "12 Street Terrace",
                  "line_3": null,
                  "city": "Glasgow",
                  "state": "Glasgow (City of)",
                  "zip": "G1 1RF",
                  "country": "GB",
                  "note": "Ask for JD"
                },
                "default_shipping_address":{
                  "id": 1000003,
                  "code": "ADDR1",
                  "name": "Jonh Doe",
                  "company": "EvolutionX",
                  "phone": "+1 98765432",
                  "line_1": "Building 3",
                  "line_2": "12 Street Terrace",
                  "line_3": null,
                  "city": "Glasgow",
                  "state": "Glasgow (City of)",
                  "zip": "G1 1RF",
                  "country": "GB",
                  "note": "Ask for JD"
                },
                "pricing": {
                  "pricing_module": true,
                  "pricing_email": "mytest@email.com",
                  "show_cheapest_price": false,
                  "exclude_global_contract": false,
                  "pricing_override_addtocart": true,
                },
                "tax": {
                  "override": false,
                  "override_amount": null,
                  "override_shipping": false,
                  "override_shipping_amount": null,
                },
                "shipping": {
                  "override": false,
                  "override_amount": null,
                },
                "labels": [
                    {
                        "id": 7,
                        "name": "B2B",
                        "hex": "B60205",
                        "type_id": 1,
                        "type": "customer",
                        "enabled": true,
                        "created_at": 1517844556,
                        "updated_at": 1517844556
                    }
                ],
                "created_at": 1516693636,
                "updated_at": 1516693636
            }
        ]
    }
    

    This endpoint retrieves all customers.

    HTTP Request

    GET https://us.evoapi.io/customers

    Query Parameters

    Parameter Description Example
    limit The number of customers you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1111122
    ids A list of ids you want to filter customers. 1111122,1111123,1111125
    company The company value you want to filter by.
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    enabled True if you want to get only enabled customers. true
    account_number Filter by the customers account number EVOX001
    parent_id Return all customers where their parent ID is the given value. 1111122
    created_at The creation date of the customers. It could either be a Unix timestamp or a dictionary for date ranges. 1516693636
    updated_at The last update of the customers. Same as the rule above. 1516693636

    Create customer

    The create customer request gives you the ability to create a customer, user and address in one shot.

    It is a three step process where by the customer is created first, then the address and then the user. If at any point the address or user creation process fails you will be returned an error outlining what went wrong but the previous steps will have run regardless.

    Example: If the user fails but the customer and address did not this means your customer and address are now available but you will have to reimport the user manually, correcting what was wrong.

    Example POST Request

    curl "https://us.evoapi.io/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{"company":"EvolutionX","account_number":"EVOX001","phone":"+1 23456789","fax":"+1 23456789","logo":"null", "parent_id: "1436879", tax_number":"null","company_number":"null","duns_number":"null","credit_account":false,"seller_reference":"null","pricing":{"show_cheapest_price":false,"exclude_global_contract":false},"tax":{"override":false,"override_shipping":false,"override_amount":"0","override_shipping_amount":"0"},"shipping":{"override":false,"override_amount":"0"},"address":{"title":"SHOULD BE DEFAULT","code":"null","name":"Jonh Doe","company":"EvolutionX","phone":"+1 98765432","line_1":"Building 3","line_2":"12 Street Terrace","line_3":"null","city":"Glasgow","state":"Glasgow (City of)","zip":"G1 1RF","country":"GB","note":"Ask for JD","seller_reference":"ADDR1","billing_default":true,"shipping_default":true},"user":{"name":"John Doe","email":"johns@example.com","company":"EvolutionX","phone":"+1 98765432","fax":"null","cell":"null","logo":"null","username":"JohnDoe","role_id":1}}'
    

    JSON

    {
      "company": "EvolutionX",
      "account_number": "EVOX001",
      "admin_email": "admin@company.com",
      "phone": "+1 23456789",
      "fax": "+1 23456789",
      "logo": "",
      "parent_id": "1436879",
      "tax_number": "",
      "company_number": "",
      "duns_number": "",
      "credit_account": false,
      "seller_reference": "",
      "branch": 1,
      "account_manager": 8,
      "pricing": {
        "pricing_module": true,
        "pricing_email": "mytest@email.com",
        "show_cheapest_price": false,
        "exclude_global_contract": false,
        "pricing_override_addtocart": true,
      },
      "tax": {
        "override": false,
        "override_shipping": false,
        "override_amount": "0",
        "override_shipping_amount": "0"
      },
      "shipping": {
        "override": false,
        "override_amount": "0"
      },
      "address": {
        "title": "SHOULD BE DEFAULT",
        "code": "",
        "name": "John Doe",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "line_1": "Building 3",
        "line_2": "12 Street Terrace",
        "line_3": "",
        "city": "Glasgow",
        "state": "Glasgow (City of)",
        "zip": "G1 1RF",
        "country": "GB",
        "note": "Ask for JD",
        "seller_reference": "ADDR1",
        "billing_default": true,
        "shipping_default": true
      },
      "user":{
        "name": "John Doe",
        "email": "johns@example.com",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "fax": "",
        "cell": "",
        "logo": "",
        "username": "JohnDoe",
        "role_id": 1,
        "seller_reference": "my seller reference"
      },
      "cost_center": {
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "budget": {
          "value": 1000,
          "approver_id": 1000031,
          "reset_period": 2,
          "from": 1525305600,
          "to": 1527724800
        }
      }
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers

    Attributes

    Attribute Description
    company string required The customer company name
    account_number string The customer account number. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
    admin_email string The customer admin email address. This field if not populated will inherit the email address of the first user you add to the customer.
    phone string The customer phone
    fax string The customer fax
    logo string The customer logo
    parent_id integer Another customer id which you would want to make the parent of this customer.
    tax_number string The customer tax number
    company_number string The customer number
    duns_number string The Dun and Bradstreet Number
    credit_account string Does this customer have a credit account
    seller_reference string The customer seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    branch integer Branch id
    account_manager integer Account manager id
    pricing object An object containing data about pricing options
      pricing_module   boolean Is the live pricing module being used Note: If you are using a live pricing module the Account Number field is required.
      pricing_email   string Email used for live pricing module.
      show_cheapest_price   boolean Show the cheapest price
      exclude_global_contract   boolean Exclude the global contract
      pricing_override_addtocart   boolean Overrides the user's Add To Cart role. When true it hides the add to cart button for this customer account even if the user role enables it. This can be used to prevent ordering on a customer account.
    tax object An object containing data about tax overrides
      override   boolean Tax override
      override_shipping   boolean Show the cheapest price
      override_amount   decimal Exclude the global contract
      override_shipping_amount   decimal Exclude the global contract
    shipping object An object containing data about shipping overrides
      override   boolean Shipping override status
      override_amount   decimal Shipping override price
    address object optional Optional address object if you'd like to create one at the same time as the customer
      title   string The address title/label
      code   string The code associated to the address
      name   string The customer name on the address
      company   string The customer name on the address
      phone   string The customer phone number on the address
      line_1   string   required The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county - This is a required field for the US and CA only
      zip   string The address zip / postcode - This is a required field for the UK, US and CA only
      country   string   required Two-letter ISO code representing the address country
      note   string The address note
      seller_reference   string The address seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
      billing_default   boolean Will this address be the customer default billing address
      shipping_default   boolean Will this address be the customer default shipping address
    user object optional Optional user object if you'd like to create one at the same time as the customer
      name   string The users name
      email   string   required The users email
      company   string The users company
      phone   string The users phone number
      fax   string The users fax number
      cell   string The users cell number
      logo   string The users logo
      username   string The username field is only used in the case where several users wish to use the same email. i.e. email: admin@mystore.com username: admin1, email: admin@mystore.com username: admin2
      role_id   integer The id for the users role (if no role is provided this field will inhert the 'Business default role' set in the admin panel of this store)
      seller_reference   string The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    cost_center object optional Optional cost center object if you'd like to create one at the same time as the customer
      code   string   required The cost center code
      description   string The cost center description
      seller_reference   string The cost center seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
      budget   object   optional You can create one optional budget on the fly when creating a cost center
        value    decimal   required The budgets value
        approver_id    integer The approver user id
        reset_period    integer   required The reset period for this budget
        from     timestamp   required The budgets from date (Unix timestamp in UTC).
        to     timestamp The budgets to date (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "customer": {
            "id": 1000252,
            "company": "EvolutionX",
            "account_number": "EVOX001",
            "phone": "+1 23456789",
            "fax": "+1 23456789",
            "logo": "",
            "parent_id": "1436879",
            "enabled": true,
            "tax_number": "",
            "company_number": "",
            "duns_number": "",
            "credit_account": false,
            "seller_reference": "",
            "child_account_ids": [1000021, 1000045],
            "branch": {
              "id": 1,
              "name": "My Main Branch",
              "code": "MAIN",
              "email": "admin@mystore.com"
            },
            "account_manager": {
              "id": 8,
              "seller_reference": "John",
              "name": "Doe",
              "email": "john@example.com"
            },
            "default_billing_address": {
                "id": 1000252,
                "title": "Office",
                "code": "Address Code",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": "Line 3",
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
                "seller_reference": "ADDR1"
            },
            "default_shipping_address": {
                "id": 1000252,
                "title": "Office",
                "code": "Address Code",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": "Line 3",
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
                "seller_reference": "ADDR1"
            },
            "pricing": {
                "show_cheapest_price": false,
                "exclude_global_contract": false,
                "pricing_override_addtocart": true,
            },
            "tax": {
                "override": false,
                "override_amount": 0,
                "override_shipping": false,
                "override_shipping_amount": 0
            },
            "shipping": {
                "override": false,
                "override_amount": 0
            },
            "created_at": 1522150598,
            "updated_at": 1522150595
        },
        "address": {
            "id": 1000252,
            "title": "Office",
            "code": "Address Code",
            "name": "John Doe",
            "company": "EvolutionX",
            "phone": "+1 98765432",
            "line_1": "Building 3",
            "line_2": "12 Street Terrace",
            "line_3": "Line 3",
            "city": "Glasgow",
            "state": "Glasgow (City of)",
            "zip": "G1 1RF",
            "country": "GB",
            "note": "Ask for JD",
            "seller_reference": "ADDR1",
            "enabled": true,
            "created_at": 1522150598,
            "updated_at": 1522150598
        },
        "user": {
            "id": 1000197,
            "customer_id": 1000252,
            "name": "John Doe",
            "email": "johns@example.com",
            "company": "EvolutionX",
            "phone": "+1 98765432",
            "fax": "",
            "cell": "",
            "logo": "",
            "username": "JohnDoe",
            "seller_reference": null,
            "role_id": 1,
            "role_name": "Guest",
            "enabled": true,
            "default_billing_address": null,
            "default_shipping_address": null,
            "default_cost_center_id": null,
            "default_department_id": null,
            "created_at": 1522150598,
            "updated_at": 1522150598
        },
        "cost_center": {
            "id": 398,
            "code": "My Cost Center",
            "description": "This is my cost center",
            "seller_reference": "Seller Ref",
            "budgets": [
                {
                    "id": 58,
                    "value": 1000,
                    "approver_id": 1000031,
                    "reset_period": 2,
                    "from": 1525651200,
                    "to": 1525651200,
                    "enabled": true,
                    "created_at": 1525719674,
                    "updated_at": 1525719674
                }
            ],
            "enabled": true,
            "created_at": 1525719674,
            "updated_at": 1525719674
        }
    }
    

    Using this request you may encounter a warning response if say the customer was created correctly but there was issue creating the user or address:

    {
        "status": "warning",
        "customer": {
            "id": 1000252,
            "company": "EvolutionX",
            "account_number": "EVOX001",
            "phone": "+1 23456789",
            "fax": "+1 23456789",
            "logo": "",
            "parent_id": "1436879",
            "enabled": true,
            "tax_number": "",
            "company_number": "",
            "duns_number": "",
            "credit_account": false,
            "seller_reference": "",
            "child_account_ids": [1000021, 1000045],
            "default_billing_address": {
                "id": 1000252,
                "title": "Office",
                "code": "Address Code",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": "Line 3",
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
                "seller_reference": "ADDR1"
            },
            "default_shipping_address": {
                "id": 1000252,
                "title": "Office",
                "code": "Address Code",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": "Line 3",
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
                "seller_reference": "ADDR1"
            },
            "pricing": {
                "show_cheapest_price": false,
                "exclude_global_contract": false
            },
            "tax": {
                "override": false,
                "override_amount": 0,
                "override_shipping": false,
                "override_shipping_amount": 0
            },
            "shipping": {
                "override": false,
                "override_amount": 0
            },
            "created_at": 1522150598,
            "updated_at": 1522150595
        },
        "address": {
            "id": 1000252,
            "title": "Office",
            "code": "Address Code",
            "name": "John Doe",
            "company": "EvolutionX",
            "phone": "+1 98765432",
            "line_1": "Building 3",
            "line_2": "12 Street Terrace",
            "line_3": "Line 3",
            "city": "Glasgow",
            "state": "Glasgow (City of)",
            "zip": "G1 1RF",
            "country": "GB",
            "note": "Ask for JD",
            "seller_reference": "ADDR1",
            "enabled": true,
            "created_at": 1522150598,
            "updated_at": 1522150598
        },
        "user": {
            "errors": {
                "email": [
                    "This email & username combination already exists in the database."
                ]
            }
        }
    }
    

    Update customer

    Update customer by providing the id and fields you wish to update.

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d "company=JohnDoe Company&seller_reference=jd-C123"
    
    OR as a JSON
    
    curl "https://us.evoapi.io/customers/customer_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -H "Content-Type: application/json" \
      -X PUT -d '{"company":"JohnDoe Company","seller_reference":"jd-C123"}'
    

    JSON

    {
      "company": "EvolutionX",
      "account_number": "EVOX001",
      "admin_email": "admin@company.com",
      "phone": "+1 23456789",
      "fax": "+1 23456789",
      "logo": "customer.jpg",
      "parent_id": "1436879",
      "enabled": true,
      "tax_number": "TAX001",
      "company_number": "CO12345",
      "duns_number": "12345",
      "credit_account": false,
      "seller_reference": "My Seller Reference",
      "branch": 1,
      "account_manager": 8,
      "default_billing_address": 15,
      "default_shipping_address": 20,
      "pricing": {
        "pricing_module": true,
        "pricing_email": "mytest@email.com",
        "show_cheapest_price": false,
        "exclude_global_contract": false,
        "pricing_override_addtocart": true,
      },
      "tax": {
        "override": false,
        "override_shipping": false,
        "override_amount": 2.00,
        "override_shipping_amount": 10.00
      },
      "shipping": {
        "override": false,
        "override_amount": 15.00
      }
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id

    Attributes

    Attribute Description
    company string The customer company name
    account_number string The customer account number. The address seller reference. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
    admin_email string The customer admin email address. This field if not populated will inherit the email address of the first user you add to the customer.
    phone string The customer phone
    fax string The customer fax
    logo string The customer logo
    parent_id integer Another customer id which you would want to make the parent of this customer.
    enabled boolean True if the customer is enabled
    tax_number string The customer tax number
    company_number string The customer number
    duns_number string The Dun and Bradstreet Number
    credit_account boolean Does this customer have a credit account
    seller_reference string The customer seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    branch integer Branch id - It can be unset with null
    account_manager integer Account manager id - It can be unset with null
    default_billing_address integer Default billing address id.
    default_shipping_address integer Default shipping address id.
    pricing object An object containing data about pricing options
      pricing_module   boolean Is the live pricing module being used Note: If you are using a live pricing module the Account Number field is required.
      pricing_email   string Email used for live pricing module.
      show_cheapest_price   boolean Show the cheapest price
      exclude_global_contract   boolean Exclude the global contract
      pricing_override_addtocart   boolean Overrides the user's Add To Cart role. When true it hides the add to cart button for this customer account even if the user role enables it. This can be used to prevent ordering on a customer account.
    tax object An object containing data about tax overrides
      override   boolean Tax override
      override_shipping   boolean Show the cheapest price
      override_amount   decimal Exclude the global contract
      override_shipping_amount   decimal Exclude the global contract
    shipping object An object containing data about shipping overrides
      override   boolean Shipping override status
      override_amount   decimal Shipping override price
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "customer": {
            "id": 1000000,
            "company": "EvolutionX",
            "account_number": "EVOX001",
            "phone": "+1 23456789",
            "fax": null,
            "logo": null,
            "parent_id": "1436879",
            "enabled": true,
            "tax_number": null,
            "company_number": null,
            "duns_number": null,
            "credit_account": false,
            "seller_reference": null,
            "child_account_ids": [1000021, 1000045],
            "branch": {
              "id": 1,
              "name": "My Main Branch",
              "code": "MAIN",
              "email": "admin@mystore.com"
            },
            "account_manager": {
              "id": 8,
              "seller_reference": "John",
              "name": "Doe",
              "email": "john@example.com"
            },
            "default_billing_address":{
              "id": 1000003,
              "code": "ADDR1",
              "name": "Jonh Doe",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "line_1": "Building 3",
              "line_2": "12 Street Terrace",
              "line_3": null,
              "city": "Glasgow",
              "state": "Glasgow (City of)",
              "zip": "G1 1RF",
              "country": "GB",
              "note": "Ask for JD"
            },
            "default_shipping_address":{
              "id": 1000003,
              "code": "ADDR1",
              "name": "Jonh Doe",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "line_1": "Building 3",
              "line_2": "12 Street Terrace",
              "line_3": null,
              "city": "Glasgow",
              "state": "Glasgow (City of)",
              "zip": "G1 1RF",
              "country": "GB",
              "note": "Ask for JD"
            },
            "pricing": {
              "pricing_module": true,
              "pricing_email": "mytest@email.com",
              "show_cheapest_price": false,
              "exclude_global_contract": false,
              "pricing_override_addtocart": true,
            },
            "tax": {
              "override": false,
              "override_amount": null,
              "override_shipping": false,
              "override_shipping_amount": null,
            },
            "shipping": {
              "override": false,
              "override_amount": null,
            },
            "created_at": 1516693636,
            "updated_at": 1516693636
        }
    }
    

    The customer address object

    Example Response

    {
        "id": 1000004,
        "customer_id": 1000008,
        "title": "Office",
        "code": null,
        "name": "John Doe",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "line_1": "Building 3",
        "line_2": "12 Street Terrace",
        "line_3": null,
        "city": "Glasgow",
        "state": "Glasgow (City of)",
        "zip": "G1 1RF",
        "country": "GB",
        "note": "Ask for JD",
        "seller_reference": "ADDR1",
        "type_id": 0,
        "enabled": true,
        "created_at": 1516693636,
        "updated_at": 1516693636
    }
    

    Attributes

    Attribute Description
    id integer The address id
    customer_id integer The address customer_id
    title string The address title/label
    code string The code associated to the address
    name string The customer name on the address
    company string The customer name on the address
    phone string The customer phone number on the address
    line_1 string The address line 1
    line_2 string The address line 2
    line_3 string The address line 3
    city string The address city
    state string The address state / county - This is a required field for the US and CA only
    zip string The address zip / postcode - This is a required field for the UK, US and CA only
    country string Two-letter ISO code representing the address country
    note string The address note
    seller_reference string The address seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    type_id integer The address type id
    enabled boolean Is this address active or not
    created_at timestamp The address creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the address was last updated (Unix timestamp in UTC)

    Address Type Id's

    ID Description
    0 Default (Can be used as Billing or Shipping)
    1 Billing Address
    2 Shipping Address

    List addresses for a customer

    curl "https://us.evoapi.io/customers/customer_id/addresses" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
            {
              "id": 1000004,
              "customer_id": 1000008,
              "title": "Office",
              "code": "ADD02",
              "name": "John Doe",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "line_1": "Building 3",
              "line_2": "12 Street Terrace",
              "line_3": "Line 3",
              "city": "Glasgow",
              "state": "Glasgow (City of)",
              "zip": "G1 1RF",
              "country": "GB",
              "note": "Ask for JD",
              "seller_reference": "ADDR1",
              "type_id": 0,
              "enabled": true,
              "created_at": 1516693636,
              "updated_at": 1516693636
            }
        ]
    }
    

    This endpoint retrieves addresses for a customer.

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/addresses

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter. 1111122,1111123,1111125
    code Filter by the address code value ADD02
    line_1 Filter by the address line 1 value Building 3
    city Filter by the address city value Glasgow
    zip Filter by the address zip value G1 1RF
    state Filter by the address state value Glasgow (City of)
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    type_id Filter by the address type 1
    enabled True if you want to get only enabled customers. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Create address for a customer

    Create an address for a customer

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/addresses" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{"title":"Office","code":"Address Code","name":"John Doe","company":"EvolutionX","phone":"+1 98765432","line_1":"Building 3","line_2":"12 Street Terrace","line_3":"Line 3","city":"Glasgow","state":"Glasgow (City of)","zip":"G1 1RF","country":"GB","note":"Ask for JD","seller_reference":"ADDR1", "type_id": 1}'
    

    JSON

    {
      "title": "Office",
      "code": "Address Code",
      "name": "John Doe",
      "company": "EvolutionX",
      "phone": "+1 98765432",
      "line_1": "Building 3",
      "line_2": "12 Street Terrace",
      "line_3": "Line 3",
      "city": "Glasgow",
      "state": "Glasgow (City of)",
      "zip": "G1 1RF",
      "country": "GB",
      "note": "Ask for JD",
      "seller_reference": "ADDR1",
      "type_id": 1
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/addresses

    Attributes

    Attribute Description
    title string The address title/label
    code string The code associated to the address
    name string The customer name on the address (currently unused, in the case of orders this value is gotten from the customer redord itself)
    company string The customer name on the address (currently unused, in the case of orders this value is gotten from the customer redord itself)
    phone string The customer phone number on the address
    line_1 string required The address line 1
    line_2 string The address line 2
    line_3 string The address line 3
    city string The address city
    state string The address state / county - This is a required field for the US and CA only
    zip string The address zip / postcode - This is a required field for the UK, US and CA only
    country string required Two-letter ISO code representing the address country
    note string The address note
    seller_reference string The address seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    type_id integer The type id (if left empty the address will have a type of 0, meaning it can be used for both shipping & billing)
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "address": {
        "id": 1000069,
        "title": "Office",
        "code": "Address Code",
        "name": "John Doe",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "line_1": "Building 3",
        "line_2": "12 Street Terrace",
        "line_3": "Line 3",
        "city": "Glasgow",
        "state": "Glasgow (City of)",
        "zip": "G1 1RF",
        "country": "GB",
        "note": "Ask for JD",
        "seller_reference": "ADDR1",
        "type_id": 1,
        "enabled": true,
        "created_at": 1522149024,
        "updated_at": 1522149024
      }
    }
    

    Update address for a customer

    Update a customer address by providing the id and fields you wish to modify

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/addresses/address_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT - d '{"title":"Office","code":"Address Code","name":"John Doe","company":"EvolutionX","phone":"+1 98765432","line_1":"Building 3","line_2":"12 Street Terrace","line_3":"Line 3","city":"Glasgow","state":"Glasgow (City of)","zip":"G1 1RF","country":"GB","note":"Ask for JD","seller_reference":"ADDR1", "enabled":true}'
    

    JSON

    {
      "title": "Office",
      "code": "Address Code",
      "name": "John Doe",
      "company": "EvolutionX",
      "phone": "+1 98765432",
      "line_1": "Building 3",
      "line_2": "12 Street Terrace",
      "line_3": "Line 3",
      "city": "Glasgow",
      "state": "Glasgow (City of)",
      "zip": "G1 1RF",
      "country": "GB",
      "note": "Ask for JD",
      "seller_reference": "ADDR1",
      "enabled": true
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/addresses/address_id

    Attributes

    Attribute Description
    title string The address title/label
    code string The code associated to the address
    name string The customer name on the address (currently unused, in the case of orders this value is gotten from the customer redord itself)
    company string The customer name on the address (currently unused, in the case of orders this value is gotten from the customer redord itself)
    phone string The customer phone number on the address
    line_1 string The address line 1
    line_2 string The address line 2
    line_3 string The address line 3
    city string The address city
    state string The address state / county
    zip string The address zip / postcode
    country string The address country
    note string The address note
    seller_reference string The address seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    enabled boolean Is this address active or not
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "address": {
          "id": 1000004,
          "title": "Office",
          "code": "Address Code",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": "Line 3",
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
          "seller_reference": "ADDR1",
          "enabled": true,
          "created_at": 1516693636,
          "updated_at": 1516693636
      }
    }
    

    The customer user object

    Example Response

    {
        "id": 1000000,
        "customer_id": 1000003,
        "name": "John Doe",
        "email": "john@example.com",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "fax": null,
        "cell": null,
        "logo": null,
        "username": "JohnDoe",
        "seller_reference": "my seller reference",
        "role_id": 1,
        "role_name": "Guest",
        "enabled": true,
        "default_billing_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_shipping_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_cost_center_id": 2,
        "default_cost_center_code": "My Cost Center",
        "default_department_id": 5,
        "default_department_code": "My Department",
        "last_logon": 1574424415,
        "created_at": 1516693636,
        "updated_at": 1516693636
    }
    

    Attributes

    Attribute Description
    id integer The user id
    customer_id integer The user customer id
    name string The user name
    email string The user email
    company string The user company
    phone string The user phone number
    fax string The user fax number
    cell string The user cell number
    logo string The user logo
    username string The username field is only used in the case where several users wish to use the same email. i.e. email: admin@mystore.com username: admin1, email: admin@mystore.com username: admin2
    seller_reference string The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    role_id integer The id for the user role
    role_name string The name of the user role
    enabled boolean Is the user enabled
    default_billing_address object An object with billing address information. If there is no default address this will simply be null.
      id   integer The address id
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The address contact name
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_shipping_address object An object with shipping address information. If there is no default address this will simply be null.
      id   integer The address id
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The address contact name
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_cost_center_id integer Default cost center id
    default_cost_center_code string Default cost center code
    default_department_id integer Default department id
    default_department_code integer Default department code
    last_logon timestamp The user last logon date (Unix timestamp in UTC). If there is no last logon date this will be null.
    created_at timestamp The user creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the user was last updated (Unix timestamp in UTC)

    List users for a customer

    curl "https://us.evoapi.io/customers/customer_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
          {
              "id": 1000000,
              "customer_id": 1000003,
              "name": "John Doe",
              "email": "john@example.com",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "fax": null,
              "cell": null,
              "logo": null,
              "username": "JohnDoe",
              "seller_reference": "my seller reference",
              "role_id": 1,
              "role_name": "Guest",
              "enabled": true,
              "default_billing_address": {
                "id": 1000027,
                "title": "Billing Address (Office)",
                "code": "ADDR1",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
              },
              "default_shipping_address": {
                "id": 1000027,
                "title": "Billing Address (Office)",
                "code": "ADDR1",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
              },
              "default_cost_center_id": 2,
              "default_cost_center_code": "My Cost Center",
              "default_department_id": 5,
              "default_department_code": "My Department",
              "last_logon": 1574424415,
              "created_at": 1516693636,
              "updated_at": 1516693636
          }
        ]
    }
    

    This endpoint retrieves users for a customer.

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/users

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter by. 1111122,1111123,1111125
    username filter by the user username value. Note: The username field is only used when multiple users are using the same email address. johndoe
    email filter by the user email value. john@example.com
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    enabled True if you want to get only enabled customers. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Create user for a customer

    Create a user for a customer

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{"name":"John Doe","email":"john@example.com","company":"EvolutionX","phone":"+1 98765432","fax":"+1 98765432","cell":"+1 98765432","logo":"avatar.jpg","username":"JohnDoe","role_id":1,"enabled":true,"default_billing_address":15,"default_shipping_address":15,"default_cost_center_id":2,"default_department_id":5}'
    

    JSON

    {
      "name": "John Doe",
      "email": "john@example.com",
      "password": "dh876uu7",
      "company": "EvolutionX",
      "phone": "+1 98765432",
      "fax": "+1 98765432",
      "cell": "+1 98765432",
      "logo": "avatar.jpg",
      "username": "JohnDoe",
      "role_id": 1,
      "default_billing_address": 15,
      "default_shipping_address": 15,
      "default_cost_center_id": 2,
      "default_department_id": 5,
      "seller_reference": "my seller reference"
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/users

    Attributes

    Attribute Description
    name string The user name. If not provided it will be autogenerated from the email address.
    email string required The user email
    password string The user temporary password. Min 3 characters. If not provided a random password will be generated
    company string The user company
    phone string The user phone number
    fax string The user fax number
    cell string The user cell number
    logo string The user logo
    username string The username field is only used in the case where several users wish to use the same email. i.e. email: admin@mystore.com username: admin1, email: admin@mystore.com username: admin2
    role_id integer The id for the user role (if no role is provided this field will inhert the 'Business default role' set in the admin panel of this store)
    enabled boolean Is the user enabled
    default_billing_address integer Default billing address id
    default_shipping_address integer Default shipping address id
    default_cost_center_id integer Default cost center id
    default_department_id integer Default department id
    seller_reference string The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "user": [
        {
          "id": 1000195,
          "customer_id": 1000003,
          "name": "John Doe",
          "email": "john@example.com",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "fax": "+1 98765432",
          "cell": "+1 98765432",
          "logo": "avatar.jpg",
          "username": "JohnDoe",
          "seller_reference": "my seller reference",
          "role_id": 1,
          "role_name": "Guest",
          "enabled": true,
          "default_billing_address": 15,
          "default_shipping_address": 15,
          "default_cost_center_id": 2,
          "default_department_id": 5,
          "created_at": 1522149591,
          "updated_at": 1522149591
        }
      ]
    }
    

    Update user for a customer

    Update user by providing the user id and the fields you wish to update.

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{"name":"John Doe","email":"john@example.com","company":"EvolutionX","phone":"+1 98765432","fax":"+1 98765432","cell":"+1 98765432","logo":"avatar.jpg","username":"JohnDoe","role_id":1,"enabled":true,"default_billing_address":15,"default_shipping_address":15,"default_cost_center_id":2,"default_department_id":5,}'
    

    JSON

    {
      "name": "John Doe",
      "email": "john@example.com",
      "company": "EvolutionX",
      "phone": "+1 98765432",
      "fax": "+1 98765432",
      "cell": "+1 98765432",
      "logo": "avatar.jpg",
      "username": "JohnDoe",
      "role_id": 1,
      "enabled": true,
      "default_billing_address": 15,
      "default_shipping_address": 15,
      "default_cost_center_id": 2,
      "default_department_id": 5,
      "seller_reference": "my seller reference"
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/users/user_id

    Attributes

    Attribute Description
    name string The user name
    email string The user email
    company string The user company
    phone string The user phone number
    fax string The user fax number
    cell string The user cell number
    logo string The user logo
    username string The username field is only used in the case where several users wish to use the same email. i.e. email: admin@mystore.com username: admin1, email: admin@mystore.com username: admin2
    role_id integer The id for the user role
    enabled boolean Is the user enabled
    default_billing_address integer Default billing address id
    default_shipping_address integer Default shipping address id
    default_cost_center_id integer Default cost center id
    default_department_id integer Default department id
    seller_reference string The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "user": {
        "id": 1000000,
        "customer_id": 1000003,
        "name": "John Doe",
        "email": "john@example.com",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "fax": null,
        "cell": null,
        "logo": null,
        "username": "JohnDoe",
        "seller_reference": "my seller reference",
        "role_id": 1,
        "role_name": "Guest",
        "enabled": true,
        "default_billing_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_shipping_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_cost_center_id": 2,
        "default_department_id": 5,
        "created_at": 1516693636,
        "updated_at": 1516693636
      }
    }
    

    The user settings object

    Example Response

    {
      "requester_settings": {
          "order_settings": {
              "restrict_quicklists": true,
              "require_line_reference": false,
              "require_cost_center": true,
              "restrict_contracts": false,
              "require_po_reference": true
          },
          "address_restriction": {
              "enabled": true,
              "billing_addresses": [
                  {
                      "id": 1000004,
                      "title": "Office",
                      "code": null,
                      "name": "John Doe",
                      "company": "EvolutionX",
                      "phone": "+1 98765432",
                      "line_1": "Building 3",
                      "line_2": "12 Street Terrace",
                      "line_3": null,
                      "city": "Glasgow",
                      "state": "Glasgow (City of)",
                      "zip": "G1 1RF",
                      "country": "GB",
                      "note": "Ask for JD",
                      "seller_reference": "ADDR1",
                      "enabled": true,
                      "created_at": 1516693636,
                      "updated_at": 1516693636
                  }
              ],
              "shipping_addresses": [
                  {
                      "id": 1000004,
                      "title": "Office",
                      "code": null,
                      "name": "John Doe",
                      "company": "EvolutionX",
                      "phone": "+1 98765432",
                      "line_1": "Building 3",
                      "line_2": "12 Street Terrace",
                      "line_3": null,
                      "city": "Glasgow",
                      "state": "Glasgow (City of)",
                      "zip": "G1 1RF",
                      "country": "GB",
                      "note": "Ask for JD",
                      "seller_reference": "ADDR1",
                      "enabled": true,
                      "created_at": 1516693636,
                      "updated_at": 1516693636
                  }
              ]
          },
          "cost_center_restriction": {
              "enabled": false,
              "restrictions": [
                  {
                      "id": 8,
                      "type_id": 1,
                      "seller_reference": null,
                      "code": "TESTCC",
                      "name": "My Cost Center",
                      "created_at": 1523530372,
                      "updated_at": 1523530372
                  }
              ]
          },
          "orders_require_approval": {
              "enabled": false,
              "approvers": [
                  {
                      "id": 1000000,
                      "customer_id": 1000003,
                      "name": "John Doe",
                      "email": "john@example.com",
                      "company": "EvolutionX",
                      "phone": "+1 98765432",
                      "fax": null,
                      "cell": null,
                      "logo": null,
                      "username": "JohnDoe",
                      "seller_reference": "my seller reference",
                      "role_id": 1,
                      "role_name": "Guest",
                      "enabled": true,
                      "default_billing_address": null,
                      "default_shipping_address": null,
                      "default_cost_center_id": 2,
                      "default_department_id": 5,
                      "created_at": 1516693636,
                      "updated_at": 1516693636
                  }
              ],
              "maximum_product_price": 99,
              "minimum_order_amount": 0,
              "maximum_order_amount": 99,
              "pre_approve_quicklist": false,
              "pre_approve_contract": false,
              "super_approver": false,
              "on_leave": false
          },
          "customer_restrictions": [1000021, 1000045],
      },
      "approval_settings": {
          "maximum_product_price": 99,
          "minimum_order_amount": 99,
          "maximum_order_amount": 99,
          "super_approver": false,
          "on_leave": true,
          "approver_require_approval": {
              "enabled": true,
              "approvers": [
                {
                    "id": 1000000,
                    "customer_id": 1000003,
                    "name": "John Doe",
                    "email": "john@example.com",
                    "company": "EvolutionX",
                    "phone": "+1 98765432",
                    "fax": null,
                    "cell": null,
                    "logo": null,
                    "username": "JohnDoe",
                    "seller_reference": "my seller reference",
                    "role_id": 1,
                    "role_name": "Guest",
                    "enabled": true,
                    "default_billing_address": null,
                    "default_shipping_address": null,
                    "default_cost_center_id": 2,
                    "default_department_id": 5,
                    "created_at": 1516693636,
                    "updated_at": 1516693636
                }
              ]
          }
      }
    }
    

    Attributes

    Attribute Description
    requester_settings object An object with user requester settings
      order_settings   object An object with the requester order settings.
        restrict_quicklists     boolean Restrict quicklists
        require_line_reference     boolean Require a line reference
        require_cost_center     boolean Require a cost center
        restrict_contracts     boolean Restrict contracts
        require_po_reference     boolean Require a PO Reference
      address_restriction   object An object with the address restrictions settings.
        enabled     boolean enable address restrictions
        billing_addresses     array Array of billing address restrictions. See address documentation
        shipping_addresses     array Array of shipping address restrictions. See address documentation
        cost_center_restriction     object object of cost center restrictions
          enabled       boolean Enabled cost center restrictions
          restrictions       array An array of cost center restrictions
          id       integer The cost centers id.
          type_id       integer The type id
          seller_reference       string The cost centers seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
          code       string The cost centers code
          name       string The cost centers name
          created_at       timestamp The cost centers creation date as a Unix timestamp
          updated_at       timestamp The cost centers update date as a Unix timestamp
      orders_require_approval   object The orders require approval object
        enabled     boolean Enabled the orders require approval
        approvers     array Array of approvers, see customer user documentation
        maximum_product_price     decimal Maximum product price
        minimum_order_amount     decimal Minimum order amount
        maximum_order_amount     decimal Maximum order amount
        pre_approve_quicklist     boolean Pre approve quicklist
        pre_approve_contract     boolean Pre approve contract
        super_approver     boolean Requester super approver
        on_leave     boolean Approver on leave
      customer_restriction     array An array of valid customer ids
    approval_settings object An object with user approval settings
      maximum_product_price   decimal The maximum product price
      minimum_order_amount   decimal The minimum order amount
      maximum_order_amount   decimal The maximum order amount
      super_approver   boolean Super approver
      on_leave   boolean Approver on leave
      approver_require_approval   object Approver requires approval settings
        enabled     boolean Does this approver require approval
        approvers     array A list of approvers that need to approve this user. see customer user documentation

    List all user settings

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/settings" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "settings": {
          "requester_settings": {
              "order_settings": {
                  "restrict_quicklists": true,
                  "require_line_reference": false,
                  "require_cost_center": true,
                  "restrict_contracts": false,
                  "require_po_reference": true
              },
              "address_restriction": {
                  "enabled": true,
                  "billing_addresses": [
                      {
                          "id": 1000004,
                          "title": "Office",
                          "code": null,
                          "name": "John Doe",
                          "company": "EvolutionX",
                          "phone": "+1 98765432",
                          "line_1": "Building 3",
                          "line_2": "12 Street Terrace",
                          "line_3": null,
                          "city": "Glasgow",
                          "state": "Glasgow (City of)",
                          "zip": "G1 1RF",
                          "country": "GB",
                          "note": "Ask for JD",
                          "seller_reference": "ADDR1",
                          "enabled": true,
                          "created_at": 1516693636,
                          "updated_at": 1516693636
                      }
                  ],
                  "shipping_addresses": [
                      {
                          "id": 1000004,
                          "title": "Office",
                          "code": null,
                          "name": "John Doe",
                          "company": "EvolutionX",
                          "phone": "+1 98765432",
                          "line_1": "Building 3",
                          "line_2": "12 Street Terrace",
                          "line_3": null,
                          "city": "Glasgow",
                          "state": "Glasgow (City of)",
                          "zip": "G1 1RF",
                          "country": "GB",
                          "note": "Ask for JD",
                          "seller_reference": "ADDR1",
                          "enabled": true,
                          "created_at": 1516693636,
                          "updated_at": 1516693636
                      }
                  ]
              },
              "cost_center_restriction": {
                  "enabled": false,
                  "restrictions": []
              },
              "orders_require_approval": {
                  "enabled": false,
                  "approvers": [
                      {
                          "id": 1000000,
                          "customer_id": 1000003,
                          "name": "John Doe",
                          "email": "john@example.com",
                          "company": "EvolutionX",
                          "phone": "+1 98765432",
                          "fax": null,
                          "cell": null,
                          "logo": null,
                          "username": "JohnDoe",
                          "seller_reference": "my seller reference",
                          "role_id": 1,
                          "role_name": "Guest",
                          "enabled": true,
                          "default_billing_address": null,
                          "default_shipping_address": null,
                          "default_cost_center_id": 2,
                          "default_department_id": 5,
                          "created_at": 1516693636,
                          "updated_at": 1516693636
                      }
                  ],
                  "maximum_product_price": 99,
                  "minimum_order_amount": 0,
                  "maximum_order_amount": 99,
                  "pre_approve_quicklist": false,
                  "pre_approve_contract": false,
                  "super_approver": false,
                  "on_leave": false
              },
              "customer_restrictions": [1000021, 1000045],
          },
          "approval_settings": {
              "maximum_product_price": 99,
              "minimum_order_amount": 99,
              "maximum_order_amount": 99,
              "super_approver": false,
              "on_leave": true,
              "approver_require_approval": {
                  "enabled": true,
                  "approvers": [
                    {
                        "id": 1000000,
                        "customer_id": 1000003,
                        "name": "John Doe",
                        "email": "john@example.com",
                        "company": "EvolutionX",
                        "phone": "+1 98765432",
                        "fax": null,
                        "cell": null,
                        "logo": null,
                        "username": "JohnDoe",
                        "seller_reference": "my seller reference",
                        "role_id": 1,
                        "role_name": "Guest",
                        "enabled": true,
                        "default_billing_address": null,
                        "default_shipping_address": null,
                        "default_cost_center_id": 2,
                        "default_department_id": 5,
                        "created_at": 1516693636,
                        "updated_at": 1516693636
                    }
                  ]
              }
          }
        }
    }
    

    This endpoint retrieves all customer user settings .

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/users/user_id/settings

    Update user settings

    Update user settings by providing the user id and the fields you wish to update as a PUT request.

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/settings" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{"requester_settings":{"order_settings":{"restrict_quicklists":true,"require_line_reference":false,"require_cost_center":true,"restrict_contracts":false,"require_po_reference":true},"address_restriction":{"enabled":true,"billing_addresses":[1000004],"shipping_addresses":[1000004]},"cost_center_restriction":{"enabled":false,"restrictions":[8]},"orders_require_approval":{"enabled":false,"approvers":[1000000],"maximum_product_price":99,"minimum_order_amount":0,"maximum_order_amount":99,"pre_approve_quicklist":false,"pre_approve_contract":false,"super_approver":false,"on_leave":false},"customer_restriction":[1000000]},"approval_settings":{"maximum_product_price":99,"minimum_order_amount":99,"maximum_order_amount":99,"super_approver":false,"on_leave":true,"approver_require_approval":{"enabled":true,"approvers":[1000000]}}}'
    

    JSON

    {
      "requester_settings": {
          "order_settings": {
              "restrict_quicklists": true,
              "require_line_reference": false,
              "require_cost_center": true,
              "restrict_contracts": false,
              "require_po_reference": true
          },
          "address_restriction": {
              "enabled": true,
              "billing_addresses": [1000004],
              "shipping_addresses": [1000004]
          },
          "cost_center_restriction": {
              "enabled": false,
              "restrictions": [8]
          },
          "orders_require_approval": {
              "enabled": false,
              "approvers": [1000000],
              "maximum_product_price": 99,
              "minimum_order_amount": 0,
              "maximum_order_amount": 99,
              "pre_approve_quicklist": false,
              "pre_approve_contract": false,
              "super_approver": false,
              "on_leave": false
          },
          "customer_restriction": [1000000]
      },
      "approval_settings": {
          "maximum_product_price": 99,
          "minimum_order_amount": 99,
          "maximum_order_amount": 99,
          "super_approver": false,
          "on_leave": true,
          "approver_require_approval": {
              "enabled": true,
              "approvers": [1000000]
          }
      }
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/users/user_id/settings

    Attributes

    Attribute Description
    requester_settings object An object with user requester settings
      order_settings   object An object with the requester order settings.
        restrict_quicklists     boolean Restrict quicklists
        require_line_reference     boolean Require a line reference
        require_cost_center     boolean Require a cost center
        restrict_contracts     boolean Restrict contracts
        require_po_reference     boolean Require a PO Reference
      address_restriction   object An object with the address restrictions settings.
        enabled     boolean enable address restrictions
        billing_addresses     array An array of address id's
        shipping_addresses     array An array of address id's
        cost_center_restriction     object object of cost center restrictions
          enabled       boolean Enabled cost center restrictions
          restrictions       array An array of cost center ids
      orders_require_approval   object The orders require approval object
        enabled     boolean Enabled the orders require approval
        approvers     array An array of valid user id's you wish to add to this list
        maximum_product_price     decimal Maximum product price
        minimum_order_amount     decimal Minimum order amount
        maximum_order_amount     decimal Maximum order amount
        pre_approve_quicklist     boolean Pre approve quicklist
        pre_approve_contract     boolean Pre approve contract
        super_approver     boolean Requester super approver
        on_leave     boolean Approver on leave
      customer_restriction   array An array of valid customer id's you wish to add to this list
    approval_settings object An object with user approval settings
      maximum_product_price   decimal The maximum product price
      minimum_order_amount   decimal The minimum order amount
      maximum_order_amount   decimal The maximum order amount
      super_approver   boolean Super approver
      on_leave   boolean Approver on leave
      approver_require_approval   object Approver requires approval settings
        enabled     boolean Does this approver require approval
        approvers     array An array of valid user id's you wish to add to this list

    The above command returns JSON structured like this:

    {
        "status": "success",
        "settings": {
          "requester_settings": {
              "order_settings": {
                  "restrict_quicklists": true,
                  "require_line_reference": false,
                  "require_cost_center": true,
                  "restrict_contracts": false,
                  "require_po_reference": true
              },
              "address_restriction": {
                  "enabled": true,
                  "billing_addresses": [
                      {
                          "id": 1000004,
                          "title": "Office",
                          "code": null,
                          "name": "John Doe",
                          "company": "EvolutionX",
                          "phone": "+1 98765432",
                          "line_1": "Building 3",
                          "line_2": "12 Street Terrace",
                          "line_3": null,
                          "city": "Glasgow",
                          "state": "Glasgow (City of)",
                          "zip": "G1 1RF",
                          "country": "GB",
                          "note": "Ask for JD",
                          "seller_reference": "ADDR1",
                          "enabled": true,
                          "created_at": 1516693636,
                          "updated_at": 1516693636
                      }
                  ],
                  "shipping_addresses": [
                      {
                          "id": 1000004,
                          "title": "Office",
                          "code": null,
                          "name": "John Doe",
                          "company": "EvolutionX",
                          "phone": "+1 98765432",
                          "line_1": "Building 3",
                          "line_2": "12 Street Terrace",
                          "line_3": null,
                          "city": "Glasgow",
                          "state": "Glasgow (City of)",
                          "zip": "G1 1RF",
                          "country": "GB",
                          "note": "Ask for JD",
                          "seller_reference": "ADDR1",
                          "enabled": true,
                          "created_at": 1516693636,
                          "updated_at": 1516693636
                      }
                  ]
              },
              "cost_center_restriction": {
                  "enabled": false,
                  "restrictions": []
              },
              "orders_require_approval": {
                  "enabled": false,
                  "approvers": [
                      {
                          "id": 1000000,
                          "customer_id": 1000003,
                          "name": "John Doe",
                          "email": "john@example.com",
                          "company": "EvolutionX",
                          "phone": "+1 98765432",
                          "fax": null,
                          "cell": null,
                          "logo": null,
                          "username": "JohnDoe",
                          "seller_reference": "my seller reference",
                          "role_id": 1,
                          "role_name": "Guest",
                          "enabled": true,
                          "default_billing_address": null,
                          "default_shipping_address": null,
                          "default_cost_center_id": 2,
                          "default_department_id": 5,
                          "created_at": 1516693636,
                          "updated_at": 1516693636
                      }
                  ],
                  "maximum_product_price": 99,
                  "minimum_order_amount": 0,
                  "maximum_order_amount": 99,
                  "pre_approve_quicklist": false,
                  "pre_approve_contract": false,
                  "super_approver": false,
                  "on_leave": false
              },
              "customer_restrictions": [1000021, 1000045],
          },
          "approval_settings": {
              "maximum_product_price": 99,
              "minimum_order_amount": 99,
              "maximum_order_amount": 99,
              "super_approver": false,
              "on_leave": true,
              "approver_require_approval": {
                  "enabled": true,
                  "approvers": [
                    {
                        "id": 1000000,
                        "customer_id": 1000003,
                        "name": "John Doe",
                        "email": "john@example.com",
                        "company": "EvolutionX",
                        "phone": "+1 98765432",
                        "fax": null,
                        "cell": null,
                        "logo": null,
                        "username": "JohnDoe",
                        "seller_reference": "my seller reference",
                        "role_id": 1,
                        "role_name": "Guest",
                        "enabled": true,
                        "default_billing_address": null,
                        "default_shipping_address": null,
                        "default_cost_center_id": 2,
                        "default_department_id": 5,
                        "created_at": 1516693636,
                        "updated_at": 1516693636
                    }
                  ]
              }
          }
        }
    }
    

    Delete from user settings

    This request allows you to remove any address, cost center or user from the user settings.

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/settings" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE -d '{ "requester_settings": { "address_restriction": { "billing_addresses": [1000004], "shipping_addresses": [1000004] }, "cost_center_restriction": { "restrictions": [8] }, "orders_require_approval": { "approvers": [1000000] } },"customer_restriction":[1000000], "approval_settings": { "approver_require_approval": { "approvers": [1000000] } } }'
    

    JSON

    {
      "requester_settings": {
          "address_restriction": {
              "billing_addresses": [1000004],
              "shipping_addresses": [1000004]
          },
          "cost_center_restriction": {
              "restrictions": [8]
          },
          "orders_require_approval": {
              "approvers": [1000000]
          },
          "customer_restriction": [1000000]
      },
      "approval_settings": {
          "approver_require_approval": {
              "approvers": [1000000]
          }
      }
    }
    

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/users/user_id/settings

    Attributes

    Attribute Description
    requester_settings object An object with user requester settings
      address_restriction   object An object with the address restrictions settings.
        billing_addresses     array An array of address id's you wish to remove
        shipping_addresses     array An array of address id's you wish to remove
        cost_center_restriction     object object of cost center restrictions
          restrictions       array An array of cost center ids you wish to remove
      orders_require_approval   object The orders require approval object
        approvers     array An array of valid user id's you wish to remove
      customer_restriction   array An array of valid customer id's you wish to remove
    approval_settings object An object with user approval settings
      approver_require_approval   object Approver requires approval settings
        approvers     array An array of valid user id's you wish to remove

    The above command returns JSON structured like this:

    {
        "status": "success",
        "settings": {
          "requester_settings": {
              "order_settings": {
                  "restrict_quicklists": true,
                  "require_line_reference": false,
                  "require_cost_center": true,
                  "restrict_contracts": false,
                  "require_po_reference": true
              },
              "address_restriction": {
                  "enabled": true,
                  "billing_addresses": [],
                  "shipping_addresses": []
              },
              "cost_center_restriction": {
                  "enabled": false,
                  "restrictions": []
              },
              "orders_require_approval": {
                  "enabled": false,
                  "approvers": [],
                  "maximum_product_price": 99,
                  "minimum_order_amount": 0,
                  "maximum_order_amount": 99,
                  "pre_approve_quicklist": false,
                  "pre_approve_contract": false,
                  "super_approver": false,
                  "on_leave": false
              },
              "customer_restrictions": [1000021, 1000045],
          },
          "approval_settings": {
              "maximum_product_price": 99,
              "minimum_order_amount": 99,
              "maximum_order_amount": 99,
              "super_approver": false,
              "on_leave": true,
              "approver_require_approval": {
                  "enabled": true,
                  "approvers": []
              }
          }
        }
    }
    

    The user budgets object

    Example Response

    {
        "id": 37,
        "type_id": 1,
        "value": 13,
        "reset_period": 3,
        "from": 1523923200,
        "to": 1524960000,
        "enabled": true,
        "created_at": 1524054047,
        "updated_at": 1524055673
    }
    

    Attributes

    Attribute Description
    id integer The budgets id
    type_id integer The budgets type id
    value decimal The budgets value
    reset_period integer The reset period for this budget
    from timestamp The budgets from date (Unix timestamp in UTC).
    to timestamp The budgets to date (Unix timestamp in UTC).
    enabled integer Is this budget active
    created_at timestamp The order creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the order was last updated (Unix timestamp in UTC).

    User Budget Type ID's

    ID Description
    1 Requester Budget
    2 Approver Budget

    User Budget Reset Period ID's

    ID Description
    0 Custom Date Range
    1 Daily
    2 Weekly
    3 Monthly
    4 Quarterly
    5 Yearly

    List all user budgets

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/budgets" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "budgets": {
            "requester": [
                {
                    "id": 37,
                    "type_id": 1,
                    "value": 13,
                    "reset_period": 3,
                    "from": 1523923200,
                    "to": 1524960000,
                    "enabled": true
                }
            ],
            "approver": [
                {
                    "id": 39,
                    "type_id": 2,
                    "value": 34,
                    "reset_period": 3,
                    "from": 1523923200,
                    "to": 1524960000,
                    "enabled": true
                }
            ]
        }
    }
    

    This endpoint retrieves all customer user budgets .

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/users/user_id/budgets

    Query Parameters

    Parameter Description Example
    ids A list of ids you want to filter orders 43,44,45
    value Get budgets with a certain value 2100
    reset_period Get budgets with a certain reset period 1
    enabled True if you want to get only enabled budgets. true

    Create a user budget

    Create a user budget

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/budgets" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{"type_id":1,"value":13,"reset_period":3,"from":1523923200,"to":1524960000,"enabled":true}'
    

    JSON

    {
        "type_id": 1,
        "value": 13,
        "reset_period": 3,
        "from": 1523923200,
        "to": 1524960000
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/users/user_id/budgets

    Attributes

    Attribute Description
    type_id integer required The budgets type id
    value decimal required The budgets value
    reset_period integer required The reset period for this budget
    from timestamp required The budgets from date (Unix timestamp in UTC).
    to timestamp The budgets to date (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "budget": {
            "id": 49,
            "type_id": 1,
            "value": 13,
            "reset_period": 3,
            "from": 1523923200,
            "to": 1524960000,
            "enabled": true,
            "created_at": 1524054047,
            "updated_at": 1524055673
        }
    }
    

    Update a user budget

    Update a user budget

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/budgets/budget_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{"type_id":2,"value":99,"reset_period":2,"type":1,"from":1523923200,"to":1524960000,"enabled":true}'
    

    JSON

    {
        "type_id": 2,
        "value": 99,
        "reset_period": 3,
        "from": 1523923200,
        "to": 1524960000,
        "enabled": true
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/users/user_id/budgets/budget_id

    Attributes

    Attribute Description
    type_id integer The budgets type id
    value decimal The budgets value
    reset_period integer The reset period for this budget
    from timestamp The budgets from date (Unix timestamp in UTC).
    to timestamp The budgets to date (Unix timestamp in UTC).
    enabled boolean Set the status of this budget.
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "budget": {
            "id": 49,
            "type_id": 2,
            "value": 99,
            "reset_period": 2,
            "from": 1523923200,
            "to": 1524960000,
            "enabled": true,
            "created_at": 1524054047,
            "updated_at": 1524055673
        }
    }
    

    Delete a user budget

    Delete a user budget

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/budgets/budget_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/users/user_id/budgets/budget_id

    The above command returns JSON structured like this:

    {
        "status": "success",
        "budgets": {
            "requester": [
                {
                    "id": 48,
                    "type_id": 1,
                    "value": 13,
                    "reset_period": 3,
                    "from": 1523923200,
                    "to": 1524960000,
                    "enabled": true,
                    "created_at": 1524054025,
                    "updated_at": 1524054032
                }
            ],
            "approver": [
                {
                    "id": 50,
                    "type_id": 2,
                    "value": 99,
                    "reset_period": 2,
                    "from": 1523923200,
                    "to": 1524960000,
                    "enabled": true,
                    "created_at": 1524056755,
                    "updated_at": 1524056762
                }
            ]
        }
    }
    

    The cost centers object

    Example Response

    {
        "id": 373,
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "budgets": [
            {
                "id": 13,
                "value": 1000,
                "approver_id": 1000031,
                "reset_period": 2,
                "from": 1525305600,
                "to": 1527724800,
                "enabled": true,
                "created_at": 1525352570,
                "updated_at": 1525352572
            }
        ],
        "enabled": true,
        "created_at": 1525352570,
        "updated_at": 1525352570
    }
    

    Attributes

    Attribute Description
    id integer The cost center id
    code string The cost center code
    description string The cost center description
    seller_reference string The cost center seller reference. The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    budgets object A list of the cost center budgets
      id   integer The budgets id
      value   decimal The budgets value
      approver_id   integer The approver user id
      reset_period   integer The reset period for this budget
      from timestamp The budgets from date (Unix timestamp in UTC).
      to timestamp The budgets to date (Unix timestamp in UTC).
      enabled   boolean Is this budget active
      created_at timestamp The creation date (Unix timestamp in UTC).
      updated_at timestamp The date when this record was last updated (Unix timestamp in UTC).
    enabled boolean Is this cost center active
    created_at timestamp TThe creation date (Unix timestamp in UTC).
    updated_at timestamp The date when this record was last updated (Unix timestamp in UTC).

    Cost Centers Reset Period ID's

    ID Description
    0 Custom Date Range
    1 Daily
    2 Weekly
    3 Monthly
    4 Quarterly
    5 Yearly

    List all customer cost centers

    curl "https://us.evoapi.io/customers/customer_id/cost-centers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": null,
      "data": [
        {
          "id": 373,
          "code": "My Cost Center",
          "description": "This is my cost center",
          "seller_reference": "Seller Ref",
          "budgets": [
            {
              "id": 13,
              "value": 1000,
              "approver_id": 1000031,
              "reset_period": 2,
              "from": 1525305600,
              "to": 1527724800,
              "enabled": true,
              "created_at": 1525352570,
                "updated_at": 1525352572
            }
          ],
          "enabled": true,
          "created_at": 1525352570,
          "updated_at": 1525352570
        }
      ]
    }
    

    This endpoint retrieves all customer user budgets .

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/cost-centers

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter orders 43,44,45
    code Filter by cost center code. IT_001
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    enabled True if you want to get only enabled or disabled records. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Create a cost center

    Create a cost center

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{ "code": "My Cost Center", "description": "This is my cost center", "seller_reference": "Seller Ref", "budget": { "value": 1000, "approver_id": 1000031, "reset_period": 2, "from": 1525305600, "to": 1527724800 } }'
    

    JSON

    {
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "budget": {
            "value": 1000,
            "approver_id": 1000031,
            "reset_period": 2,
            "from": 1525305600,
            "to": 1527724800
        }
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/cost-centers

    Attributes

    Attribute Description
    code string   required The cost center code
    description string The cost center description
    seller_reference string The cost center seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    budget object You can create one budget on the fly when creating a cost center
      value   decimal   required The budgets value
      approver_id   integer The approver user id
      reset_period   integer   required The reset period for this budget
      from timestamp   required The budgets from date (Unix timestamp in UTC).
      to timestamp The budgets to date (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "cost_center": {
        "id": 373,
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "budgets": [
          {
            "id": 13,
            "value": 1000,
            "approver_id": 1000031,
            "reset_period": 2,
            "from": 1525305600,
            "to": 1527724800,
            "enabled": true,
            "created_at": 1525352570,
            "updated_at": 1525352572
          }
        ],
        "enabled": true,
        "created_at": 1525352570,
        "updated_at": 1525352570
      }
    }
    

    Update a cost center

    Update a cost center

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{ "code": "My Cost Center", "description": "This is my cost center", "seller_reference": "Seller Ref", "enabled": true }'
    

    JSON

    {
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "enabled": true
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id

    Attributes

    Attribute Description
    code string The cost center code
    description string The cost center description
    seller_reference string The cost center seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    enabled boolean Set the status of this budget.
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "cost_center": {
        "id": 373,
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "budgets": [
          {
            "id": 13,
            "value": 1000,
            "approver_id": 1000031,
            "reset_period": 2,
            "from": 1525305600,
            "to": 1527724800,
            "enabled": true,
            "created_at": 1525352570,
            "updated_at": 1525352572
          }
        ],
        "enabled": true,
        "created_at": 1525352570,
        "updated_at": 1525352570
      }
    }
    

    Delete a cost center

    Delete a cost center

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The cost centers budget object

    Example Response

    {
      "id": 32,
      "value": 1111,
      "approver_id": 1000031,
      "reset_period": 2,
      "from": 1525305600,
      "to": 1527724800,
      "enabled": true,
      "created_at": 1525432328,
      "updated_at": 1525432332
    }
    

    Attributes

    Attribute Description
    id   integer The budgets id
    value   decimal The budgets value
    approver_id   integer The approver user id
    reset_period   integer The reset period for this budget
    from timestamp The budgets from date (Unix timestamp in UTC).
    to timestamp The budgets to date (Unix timestamp in UTC).
    enabled   boolean Is this budget active
    created_at timestamp The creation date (Unix timestamp in UTC)
    updated_at timestamp The date when this record was last updated (Unix timestamp in UTC).

    Cost Centers Budget Reset Period ID's

    ID Description
    0 Custom Date Range
    1 Daily
    2 Weekly
    3 Monthly
    4 Quarterly
    5 Yearly

    List all cost centers budgets

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": null,
      "data": [
        {
          "id": 32,
          "value": 1111,
          "approver_id": 1000031,
          "reset_period": 2,
          "from": 1525305600,
          "to": 1527724800,
          "enabled": true,
          "created_at": 1525432328,
          "updated_at": 1525432332
        }
      ]
    }
    

    This endpoint retrieves all customer user budgets .

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/cost-centers

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter orders 43,44,45
    enabled True if you want to get only enabled or disabled records. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Create a cost center budget

    Create a cost center budget

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{ "value": 1000, "approver_id": 1000031, "reset_period": 2, "from": 1525305600, "to": 1527724800 }'
    

    JSON

    {
      "value": 1000,
      "approver_id": 1000031,
      "reset_period": 2,
      "from": 1525305600,
      "to": 1527724800
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets

    Attributes

    Attribute Description
    value   decimal The budgets value
    approver_id   integer The approver user id
    reset_period   integer The reset period for this budget
    from timestamp The budgets from date (Unix timestamp in UTC).
    to timestamp The budgets to date (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "budget": {
        "id": 35,
        "value": 1000,
        "approver_id": 1000031,
        "reset_period": 2,
        "from": 1525305600,
        "to": 1527724800,
        "enabled": true,
        "created_at": 1525438530,
        "updated_at": 1525438530
      }
    }
    

    Update a cost center budget

    Update a cost center budget

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets/budget_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{ "code": "My Cost Center", "description": "This is my cost center", "seller_reference": "Seller Ref", "enabled": true }'
    

    JSON

    {
      "value": 1000,
      "approver_id": 1000031,
      "reset_period": 2,
      "from": 1525305600,
      "to": 1527724800,
      "enabled": true
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets/budget_id

    Attributes

    Attribute Description
    value   decimal The budgets value
    approver_id   integer The approver user id
    reset_period   integer The reset period for this budget
    from timestamp The budgets from date (Unix timestamp in UTC).
    to timestamp The budgets to date (Unix timestamp in UTC).
    enabled boolean Set the status of this budget.
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "budget": {
        "id": 32,
        "value": 1000,
        "approver_id": 1000031,
        "reset_period": 2,
        "from": 1525305600,
        "to": 1527724800,
        "enabled": true,
        "created_at": 1525432328,
        "updated_at": 1525438715
      }
    }
    

    Delete a cost center budget

    Delete a cost center budget

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets/budget_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/budgets/budget_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The customer cost center user object

    Example Response

    {
        "id": 1000000,
        "customer_id": 1000003,
        "name": "John Doe",
        "email": "john@example.com",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "fax": null,
        "cell": null,
        "logo": null,
        "username": "JohnDoe",
        "seller_reference": "my seller reference",
        "role_id": 1,
        "role_name": "Guest",
        "enabled": true,
        "default_billing_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_shipping_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_cost_center_id": 2,
        "default_department_id": 5,
        "created_at": 1516693636,
        "updated_at": 1516693636
    }
    

    Attributes

    Attribute Description
    id integer The user id
    customer_id integer The user customer id
    name string The user name
    email string The user email
    company string The user company
    phone string The user phone number
    fax string The user fax number
    cell string The user cell number
    logo string The user logo
    username string The username field is only used in the case where several users wish to use the same email. i.e. email: admin@mystore.com username: admin1, email: admin@mystore.com username: admin2
    seller_reference string The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    role_id integer The id for the user role
    role_name string The name of the user role
    enabled boolean Is the user enabled
    default_billing_address object An object with billing address information. If there is no default address this will simply be null.
      id   integer The address id
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The address contact name
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_shipping_address object An object with shipping address information. If there is no default address this will simply be null.
      id   integer The address id
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The address contact name
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_cost_center_id integer Default cost center id
    default_department_id integer Default department id
    created_at timestamp The order creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the order was last updated (Unix timestamp in UTC)

    List users linked to a cost center

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
          {
              "id": 1000000,
              "customer_id": 1000003,
              "name": "John Doe",
              "email": "john@example.com",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "fax": null,
              "cell": null,
              "logo": null,
              "username": "JohnDoe",
              "seller_reference": "my seller reference",
              "role_id": 1,
              "role_name": "Guest",
              "enabled": true,
              "default_billing_address": {
                "id": 1000027,
                "title": "Billing Address (Office)",
                "code": "ADDR1",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
              },
              "default_shipping_address": {
                "id": 1000027,
                "title": "Billing Address (Office)",
                "code": "ADDR1",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
              },
              "default_cost_center_id": 2,
              "default_department_id": 5,
              "created_at": 1516693636,
              "updated_at": 1516693636
          }
        ]
    }
    

    This endpoint retrieves users for a customer.

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/users

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter by. 1111122,1111123,1111125
    username filter by the user username value. Note: The username field is only used when multiple users are using the same email address. johndoe
    email filter by the user email value. john@example.com
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    enabled True if you want to get only enabled customers. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Delete a cost center user

    This doesn't delete the user but instead unlinks their association to the cost center

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/users/user_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/cost-centers/cost_center_id/users/user_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The quicklist object

    Quicklists Guide

    Example Response

    {
      "id": 29,
      "type_id": 2,
      "seller_reference": null,
      "name": "My Quicklist",
      "from": 1525132800,
      "to": 1527724800,
      "items": 2,
      "users": 1,
      "enabled": true,
      "created_at": 1527600957,
      "updated_at": 1527600957
    }
    

    Attributes

    Attribute Description
    id integer The quicklist id
    type_id integer The quicklist type
    seller_reference string The quicklist seller reference
    name string The quicklist name
    from timestamp The starting date of this quicklist (Unix timestamp in UTC).
    to timestamp The ending date of this quicklist (Unix timestamp in UTC).
    items integer The number of items associated
    users integer The number of users associated
    enabled boolean Is this rule enabled
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the item was last updated (Unix timestamp in UTC).

    Quicklist Type ID's

    ID Description
    1 Personal
    2 Company Restricted (Available to listed users)
    3 Company Unrestricted (All users have access)

    List all quicklists

    curl "https://us.evoapi.io/customers/customer_id/quicklists" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 29,
        "data": [
            {
              "id": 29,
              "type_id": 2,
              "seller_reference": null,
              "name": "My Quicklist",
              "from": 1525132800,
              "to": 1527724800,
              "items": 2,
              "users": 1,
              "enabled": true,
              "created_at": 1527600957,
              "updated_at": 1527600957
            }
        ]
    }
    

    This endpoint retrieves all quicklists

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/quicklists

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    name Filter by name. My Quicklist
    type_id Filter by the type_id 1
    enabled True if you want to get only enabled items. true
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Create Quicklists

    Create a new quicklist

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "name": "My Quicklist", "type_id": 1, "seller_reference": "Seller Ref", "items": ["006-BY12YPS4CW", "007-122OS5"], "users": [1000081], "from": "1529485333", "to": "1529585333" }'
    

    JSON

    {
      "name": "My Quicklist",
        "type_id": 1,
        "seller_reference": "Seller Ref",
        "items": ["006-BY12YPS4CW", "007-122OS5"],
        "users": [1000081],
        "from": "1529485333",
        "to": "1529585333"
    }
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/quicklists

    Attributes

    Attribute Description
    name string required The quicklist name
    type_id integer required The quicklist type
    seller_reference string The quicklist seller reference
    items array An array of item skus
    users array An array of user id's (must be from same customer)
    from timestamp The starting date of this quicklist (Unix timestamp in UTC).
    to timestamp The ending date of this quicklist (Unix timestamp in UTC).
    
    

    The are 2 different responses you can get back:

    Example JSON Response when status is success

    {
        "status": "success",
        "quicklist": {
            "id": 302,
            "type_id": 1,
            "seller_reference": "Seller Ref",
            "name": "My Quicklist",
            "from": 1529452800,
            "to": 1529539200,
            "items": 2,
            "users": 1,
            "enabled": true,
            "created_at": 1529485360,
            "updated_at": 1529485360
        }
    }
    

    Example JSON Response when status is warning

    {
      "status": "warning",
      "failed": [
        {
            "data": 1000082,
            "reason": "User does not exist"
        },
        {
            "data": "006-BY12YPS4CWxxx",
            "reason": "Product does not exist"
        }
      ]
    }
    

    Update quicklist

    You would use this request to update a quicklist

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT - d '{ "name": "My Quicklist Update", "type_id": 1, "seller_reference": "Seller Ref Update", "from": "1529485333", "to": "1529585333" }'
    

    JSON

    {
      "name": "My Quicklist Update",
        "type_id": 1,
        "seller_reference": "Seller Ref Update",
        "from": "1529485333",
        "to": "1529585333"
    }
    

    HTTP Request

    PUT https://us.evoapi.io/pricing/pricing_id

    Attributes

    Attribute Description
    name string The quicklist name
    type_id integer The quicklist type
    seller_reference string The quicklist seller reference
    from timestamp The starting date of this quicklist (Unix timestamp in UTC).
    to timestamp The ending date of this quicklist (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "quicklist": {
          "id": 24,
          "name": "My Quicklist Update",
          "type_id": 1,
          "seller_reference": "Seller Ref Update",
          "from": "1529485333",
          "to": "1529585333",
          "created_at": 1528906489,
          "updated_at": 1528906489
      }
    }
    

    Delete a quicklist

    Delete a quicklist

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The quicklist user object

    Example Response

    {
        "id": 1000031,
        "customer_id": 1000002,
        "name": "John Doe",
        "email": "john@example.com",
        "company": "JD Supplies Ltd.",
        "created_at": 1527600957,
        "updated_at": 1527600957
    }
    

    Attributes

    Attribute Description
    id integer The user id
    customer_id string The customer id
    name integer The users name
    email integer The users email
    company integer The the users company
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the item was last updated (Unix timestamp in UTC).

    List all quicklist users

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000031,
        "data": [
            {
                "id": 1000031,
                "customer_id": 1000002,
                "name": "John Doe",
                "email": "john@example.com",
                "company": "JD Supplies Ltd.",
                "created_at": 1527600957,
                "updated_at": 1527600957
            }
        ]
    }
    

    This endpoint retrieves all users.

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/users

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    email Filter by email. john@doe.com
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Add quicklist users

    This request will allow you to add users to a quicklist

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ 1000338, 1000339, 1000340 ] }'
    

    JSON

    {
      "data": [
        1000338,
        1000339,
        1000340
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/users

    Attributes

    Attribute Description
    data array required An array of user id's
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": 1000338,
          "reason": "User does not exist"
        }
      ]
    }
    

    Delete a quicklist user

    Delete a user form a quicklists

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/users/user_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/users/user_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The quicklist items object

    Example Response

    {
      "sku": "006-BY12YPS4CW",
      "name": "2.5 In Liq-Filled Gauge, Stainless Case, 2,000 Psi, Brass Socket, Back Mount.",
      "supplier_id": 1034,
      "created_at": 1529485360,
      "updated_at": 1529485360
    }
    

    Attributes

    Attribute Description
    sku string The items sku
    name string The items name
    supplier_id integer The supplier id
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when this item was last updated (Unix timestamp in UTC).

    List all quicklist items

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/items" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": "006-BY12YPS4CW",
        "data": [
          {
            "sku": "006-BY12YPS4CW",
            "name": "2.5 In Liq-Filled Gauge, Stainless Case, 2,000 Psi, Brass Socket, Back Mount.",
            "supplier_id": 1034,
            "created_at": 1529485360,
            "updated_at": 1529485360
          }
        ]
    }
    

    This endpoint retrieves all items.

    HTTP Request

    GET https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/items

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    sku Filter by the item sku 100-RT-112
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Add items to quicklist

    This request will allow you to add items to a quicklist

    This is a bulk request meaning that you can update / create up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/items" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ { "type_id": 2, "catalog_id": 1000, "method_id": 1, "discount_band": "ZZ", "percentage": 20, "linked_id": 2631 } ] }'
    

    JSON

    {
      "data": ["006-BY12YPS4CW", "007-122OS5"]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/items

    Attributes

    Attribute Description
    data array required An array of item sku's
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": "007-122OS5",
          "reason": "Product does not exist."
        }
      ]
    }
    

    Delete a quicklist item

    Delete a quicklist item

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/items/itms_sku" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/quicklists/quicklist_id/items/itms_sku

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Add Labels To Customer

    This request will allow you to add labels to a customer of type customer.

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/customers/customer_id/labels" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [1, 2] }'
    

    JSON

    {
      "data": [1, 2]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/customers/customer_id/labels

    Attributes

    Attribute Description
    data array required An array of label id's, these labels must of 'customer' type.
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": 99999,
          "reason": "The label does not exist or is not of 'tax' or 'product' type"
        }
      ]
    }
    

    Delete A Label From A Customer

    Delete A Label From A Customer

    Example DELETE Request

    curl "https://us.evoapi.io/customers/customer_id/labels/label_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/customers/customer_id/labels/label_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Update Customer Account Managers List

    Update the Account Managers assigned to a Customer. The account managers list will overwrite the existing.

    Example PUT Request

    curl "https://us.evoapi.io/customers/customer_id/users/user_id/settings" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{ "account_manager_list": [32,33] }'
    

    JSON

    {
        "account_manager_list": [32,33]
    }
    

    HTTP Request

    PUT https://us.evoapi.io/customers/customer_id/account_manager_list

    Attributes

    Attribute Description
    account_manager_list array An array with the Account Managers Ids

    The above command returns JSON structured like this:

    {
        "status": "success",
        "customer": {
            "id": 1436681,
            "company": "EvolutionX39713216784",
            "admin_email": "admin@company.com",
            "account_number": "EVOX001",
            "phone": "+1 23456789",
            "fax": "+1 23456789",
            "logo": "",
            "enabled": true,
            "tax_number": "123",
            "company_number": "",
            "duns_number": "",
            "credit_account": false,
            "seller_reference": "",
            "branch": null,
            "account_manager": {
                "id": 32,
                "seller_reference": "John",
                "name": "Doe",
                "title": null,
                "email": "john@example.com",
                "cell": null,
                "phone": null,
                "fax": null,
                "comments": null,
                "image": null,
                "image_path": null
            },
            "account_manager_list": [
                32,
                33
            ],
            "default_billing_address": {
                "id": 1000003,
                "code": "ADDR1",
                "name": "Jonh Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
                "seller_reference": "ADDR1"
            },
            "default_shipping_address": {
                "id": 1000003,
                "code": "ADDR1",
                "name": "Jonh Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
                "seller_reference": "ADDR1"
            },
            "pricing": {
                "pricing_module": true,
                "pricing_email": "mytest1@email.com",
                "show_cheapest_price": false,
                "exclude_global_contract": false
            },
            "tax": {
                "override": false,
                "override_amount": 21,
                "override_shipping": false,
                "override_shipping_amount": 101
            },
            "shipping": {
                "override": false,
                "override_amount": 151
            },
            "labels": [],
            "created_at": 1601374294,
            "updated_at": 1601478901
        }
    }
    

    Customer Product Codes

    The Customer Product Code Object

    Example Response

    {
        "customer_id": 1000002,
        "data": [
          {
            "customer_product_code": "KF3454_custom",
            "sku": "KF3454",
            "created_at": 1571234159,
            "updated_at": 1571237820
          }
        ]
    }
    

    Attributes

    Attribute Description
    customer_id integer The customer id
    data array List of product codes
     ↳ customer_product_code  string The custom product code
     ↳ sku  string Product SKU
     ↳ created_at  timestamp The records creation date (Unix timestamp in UTC)
     ↳ updated_at  timestamp The date when the record was last updated (Unix timestamp in UTC)

    Get Customer Product Codes

    This endpoint retrieves product user codes.

    curl "https://us.evoapi.io/customer-product-codes/get" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{
      "customer_id": 1000021,
      "customer_product_code": "KF3454_custom"
    }'
    

    Attributes

    Attribute Description
    customer_id integerrequired The customer id
    customer_product_code string required 1024 character limit The custom product code

    The above command returns JSON structured like this:

    {
        "status": "success",
        "customer_id": 1000021,
        "data": [
            {
                "customer_product_code": "KF3454_custom",
                "sku": "KF3454",
                "created_at": 1571237844,
                "updated_at": 1571239300
            }
        ]
    }
    

    Add or Update Product Codes

    This request will allow you to either create a new product code or update one.

    Example POST Request

    curl "https://us.evoapi.io/customer-product-codes/add" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{
      "customer_id": 1000021,
      "customer_product_code": "KF3454_custom",
      "sku": "KF3454"
    }'
    

    JSON

    {
      "customer_id": 1000021,
      "customer_product_code": "KF3454_custom",
      "sku": "KF3454"
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/customer-product-codes/add

    Attributes

    Attribute Description
    customer_id integer required The customer id.
    customer_product_code string required 1024 character limit The custom product code
    sku stringrequired 1024 character limit The product SKU
    
    

    Example JSON Response

    {"status":"success"}
    

    Delete A Customer Product Code

    Delete a Customer Product Code

    Example POST Request

    curl "https://us.evoapi.io/customer-product-codes/delete" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{
      "customer_id": 1000021,
      "customer_product_code": "KF3454_custom"
    }'
    

    JSON

    {
      "customer_id": 1000021,
      "customer_product_code": "KF3454_custom"
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/customer-product-codes/delete

    Attributes

    Attribute Description
    customer_id integer required The customer id
    customer_product_code string required 1024 character limit The custom product code
    
    

    Example JSON Response

    {"status":"success"}
    

    Get Customer Product Codes by SKU

    This endpoint retrieves product user codes.

    curl "https://us.evoapi.io/customer-product-codes/getsku" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{
      "customer_id": 1000021,
      "sku": "KF3454"
    }'
    

    HTTP Request

    POST https://us.evoapi.io/customer-product-codes/getsku

    Attributes

    Attribute Description
    customer_id integerrequired The customer id
    sku stringrequired 1024 character limit Product SKU

    The above command returns JSON structured like this:

    {
        "status": "success",
        "customer_id": 1000021,
        "data": [
            {
                "customer_product_code": "KF3454_customA",
                "sku": "KF3454",
                "created_at": 1571234159,
                "updated_at": 1571237820
            },
            {
                "customer_product_code": "KF3454_customB",
                "sku": "KF3454",
                "created_at": 1571237844,
                "updated_at": 1571239300
            }
        ]
    }
    

    Addresses

    The address object

    Example Response

    {
        "id": 1000004,
        "customer_id": 1000008,
        "title": "Office",
        "code": null,
        "name": "John Doe",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "line_1": "Building 3",
        "line_2": "12 Street Terrace",
        "line_3": null,
        "city": "Glasgow",
        "state": "Glasgow (City of)",
        "zip": "G1 1RF",
        "country": "GB",
        "note": "Ask for JD",
        "seller_reference": "ADDR1",
        "type_id": 0,
        "enabled": true,
        "created_at": 1516693636,
        "updated_at": 1516693636
    }
    

    Attributes

    Attribute Description
    id integer The address id
    customer_id integer The address customer_id
    title string The address title/label
    code string The code associated to the address
    name string The customer name on the address
    company string The customer name on the address
    phone string The customer phone number on the address
    line_1 stringrequired The address line 1
    line_2 string The address line 2
    line_3 string The address line 3
    city string The address city
    state string The address state / county - This is a required field for the US and CA only
    zip string The address zip / postcode - This is a required field for the UK, US and CA only
    country stringrequired Two-letter ISO code representing the address country
    note string The address note
    seller_reference string The address seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    type_id integer The address type id
    enabled boolean Is this address active or not
    created_at timestamp The address creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the address was last updated (Unix timestamp in UTC)

    List addresses

    curl "https://us.evoapi.io/addresses" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
            {
              "id": 1000004,
              "customer_id": 1000008,
              "title": "Office",
              "code": "ADD02",
              "name": "John Doe",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "line_1": "Building 3",
              "line_2": "12 Street Terrace",
              "line_3": "Line 3",
              "city": "Glasgow",
              "state": "Glasgow (City of)",
              "zip": "G1 1RF",
              "country": "GB",
              "note": "Ask for JD",
              "seller_reference": "ADDR1",
              "type_id": 0,
              "enabled": true,
              "created_at": 1516693636,
              "updated_at": 1516693636
            }
        ]
    }
    

    This endpoint retrieves all addresses.

    HTTP Request

    GET https://us.evoapi.io/addresses

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter. 1111122,1111123,1111125
    customer Filter by customer 1000008
    code Filter by the address code value ADD02
    line_1 Filter by the address line 1 value Building 3
    city Filter by the address city value Glasgow
    zip Filter by the address zip value G1 1RF
    state Filter by the address state value Glasgow (City of)
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    type_id Filter by the address type 1
    enabled True if you want to get only enabled customers. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Cost Centers

    The cost center object

    Example Response

    {
        "id": 373,
        "customer_id": 121234,
        "code": "My Cost Center",
        "description": "This is my cost center",
        "seller_reference": "Seller Ref",
        "budgets": [
            {
                "id": 13,
                "value": 1000,
                "approver_id": 1000031,
                "reset_period": 2,
                "from": 1525305600,
                "to": 1527724800,
                "enabled": true,
                "created_at": 1525352570,
                "updated_at": 1525352572
            }
        ],
        "enabled": true,
        "created_at": 1525352570,
        "updated_at": 1525352570
    }
    

    Attributes

    Attribute Description
    id integer The cost center id
    customer integer The customer id associate with cost center object
    code string The cost center code
    description string The cost center description
    seller_reference string The cost center seller reference. The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    budgets object A list of the cost center budgets
      id   integer The budgets id
      value   decimal The budgets value
      approver_id   integer The approver user id
      reset_period   integer The reset period for this budget
      from timestamp The budgets from date (Unix timestamp in UTC).
      to timestamp The budgets to date (Unix timestamp in UTC).
      enabled   boolean Is this budget active
      created_at timestamp The creation date (Unix timestamp in UTC).
      updated_at timestamp The date when this record was last updated (Unix timestamp in UTC).
    enabled boolean Is this cost center active
    created_at timestamp TThe creation date (Unix timestamp in UTC).
    updated_at timestamp The date when this record was last updated (Unix timestamp in UTC).

    Cost Center Reset Period ID's

    ID Description
    0 Custom Date Range
    1 Daily
    2 Weekly
    3 Monthly
    4 Quarterly
    5 Yearly

    List all cost centers

    curl "https://us.evoapi.io/cost-centers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 1000000,
      "data": [
        {
          "id": 1000000,
          "customer_id": 121234,
          "code": "My Cost Center",
          "description": "This is my cost center",
          "seller_reference": "Seller Ref",
          "budgets": [
            {
              "id": 13,
              "value": 1000,
              "approver_id": 1000031,
              "reset_period": 2,
              "from": 1525305600,
              "to": 1527724800,
              "enabled": true,
              "created_at": 1525352570,
                "updated_at": 1525352572
            }
          ],
          "enabled": true,
          "created_at": 1525352570,
          "updated_at": 1525352570
        }
      ]
    }
    

    This endpoint retrieves all user budgets .

    HTTP Request

    GET https://us.evoapi.io/cost-centers

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter orders 43,44,45
    code Filter by cost center code. IT_001
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    enabled True if you want to get only enabled or disabled records. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Users

    The user object

    Example Response

    {
        "id": 1000000,
        "customer_id": 1000003,
        "name": "John Doe",
        "email": "john@example.com",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "fax": null,
        "cell": null,
        "logo": null,
        "username": "JohnDoe",
        "seller_reference": "my seller reference",
        "role_id": 1,
        "role_name": "Guest",
        "enabled": true,
        "default_billing_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_shipping_address": {
          "id": 1000027,
          "title": "Billing Address (Office)",
          "code": "ADDR1",
          "name": "John Doe",
          "company": "EvolutionX",
          "phone": "+1 98765432",
          "line_1": "Building 3",
          "line_2": "12 Street Terrace",
          "line_3": null,
          "city": "Glasgow",
          "state": "Glasgow (City of)",
          "zip": "G1 1RF",
          "country": "GB",
          "note": "Ask for JD",
        },
        "default_cost_center_id": 2,
        "default_department_id": 5,
        "last_logon": 1574424415,
        "created_at": 1516693636,
        "updated_at": 1516693636
    }
    

    Attributes

    Attribute Description
    id integer The user id
    customer_id integer The user customer id
    name string The user name
    email string The user email
    company string The user company
    phone string The user phone number
    fax string The user fax number
    cell string The user cell number
    logo string The user logo
    username string The username field is only used in the case where several users wish to use the same email. i.e. email: admin@mystore.com username: admin1, email: admin@mystore.com username: admin2
    seller_reference string The user seller reference. Can be used to store an additional ID used by a third-party system of your choice, such as a CRM
    role_id integer The id for the user role
    role_name string The name of the user role
    enabled boolean Is the user enabled
    default_billing_address object An object with billing address information. If there is no default address this will simply be null.
      id   integer The address id
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The address contact name
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_shipping_address object An object with shipping address information. If there is no default address this will simply be null.
      id   integer The address id
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The address contact name
      company   string The customer company on the address
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county
      zip   string The address zip / postcode
      country   string Two-letter ISO code representing the address country
      note   string The address note
    default_cost_center_id integer Default cost center id
    default_department_id integer Default department id
    last_logon timestamp The user last logon date (Unix timestamp in UTC). If there is no last logon date this will be null.
    created_at timestamp The user creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the user was last updated (Unix timestamp in UTC)

    List of users

    curl "https://us.evoapi.io/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
          {
              "id": 1000000,
              "customer_id": 1000003,
              "name": "John Doe",
              "email": "john@example.com",
              "company": "EvolutionX",
              "phone": "+1 98765432",
              "fax": null,
              "cell": null,
              "logo": null,
              "username": "JohnDoe",
              "seller_reference": "my seller reference",
              "role_id": 1,
              "role_name": "Guest",
              "enabled": true,
              "default_billing_address": {
                "id": 1000027,
                "title": "Billing Address (Office)",
                "code": "ADDR1",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
              },
              "default_shipping_address": {
                "id": 1000027,
                "title": "Billing Address (Office)",
                "code": "ADDR1",
                "name": "John Doe",
                "company": "EvolutionX",
                "phone": "+1 98765432",
                "line_1": "Building 3",
                "line_2": "12 Street Terrace",
                "line_3": null,
                "city": "Glasgow",
                "state": "Glasgow (City of)",
                "zip": "G1 1RF",
                "country": "GB",
                "note": "Ask for JD",
              },
              "default_cost_center_id": 2,
              "default_department_id": 5,
              "last_logon": 1574424415,
              "created_at": 1516693636,
              "updated_at": 1516693636
          }
        ]
    }
    

    Attributes

    Attribute Description
    id The user id
    customer_id The users customer id if associated to a customer
    name The users name
    email The users email
    company The users company
    phone The users phone number
    fax The users fax number
    cell The users cell number
    logo The users logo
    username The users username
    seller_reference The users seller reference
    role_id The id for the users role
    role_name The name of the users role
    enabled Is the user enabled
    default_billing_address Default billing address id
    default_shipping_address Default shipping address id
    default_cost_center_id Default cost center id
    default_department_id Default department id

    This endpoint retrieves all users.

    HTTP Request

    GET https://us.evoapi.io/users

    Query Parameters

    Parameter Description Example
    limit The number of users you want. Default is 10 and max is 100. 10
    from_id The user id you want to start from. 1111122
    ids A list of ids you want to filter users. 1111122,1111123,1111125
    username filter by the user username value. Note: The username field is only used when multiple users are using the same email address. johndoe
    email Filter by the user email value. john@example.com
    seller_reference Filter by the seller reference. True: for records with a seller reference, False: For records without a seller reference, Or any other value to specify a specific seller reference. false
    enabled True if you want to get only enabled customers. true
    created_at The creation date of the users. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the users. Same as the rule above. 1516693636

    Inventory

    The inventory object

    Example Response

    {
      "sku": "MYSKU",
      "quantity": 150,
      "due_date": null,
      "location_id": 9999,
      "location_name": "Warehouse IE",
      "created_at": 1527513887,
      "updated_at": 1527514722
    }
    

    Attributes

    Attribute Description
    sku string The product inventory sku
    quantity integer The product inventory quantity
    due_date string The product inventory due date (Unix timestamp in UTC)
    location_id string The product inventory location id
    location_name string The product inventory location name
    created_at timestamp The product inventory creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the product inventory was last updated (Unix timestamp in UTC)

    Inventory list

    curl "https://us.evoapi.io/products/inventory" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": "MTQ5NjU2Mnx1Ng==",
      "data": [
        {
          "sku": "MYSKU",
          "quantity": 150,
          "due_date": null,
          "location_id": 9999,
          "location_name": "Warehouse",
          "created_at": 1527513887,
          "updated_at": 1527514722
        }
      ]
    }
    

    This endpoint retrieves inventory for own products.

    HTTP Request

    GET https://us.evoapi.io/products/inventory

    Query Parameters

    Parameter Description Example
    limit The number of inventories you want. Default is 10 and max is 100. 10
    from_id The inventory reference you want to start from. MTQ5NjU2Mnx1Ng==
    sku Filter inventory by sku. MYSKU
    location_id Filter inventory by location id. 9999
    created_at The creation date of the inventory. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the inventory. Same as the rule above. 1516693636

    Create or update inventory

    To create or update inventory for own products, please use the request below.

    Example POST Request

    curl "https://us.evoapi.io/products/inventory" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{"sku": "MYSKU","quantity": 1,"location_id": 9999,"due_date":1532908800}'
    

    JSON

    {
      "sku": "MYSKU",
      "quantity": 1,
      "location_id": 9999,
      "due_date": 1532908800
    }
    

    HTTP Request

    POST https://us.evoapi.io/products/inventory

    Attributes

    Attribute Description
    sku string required The product inventory sku
    quantity string required The product inventory quantity
    due_date string The product inventory due date (Unix timestamp, rounded to the nearest day)
    location_id string required The product inventory location id. Locations available to your store can be obtained through Suppliers
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "inventory": {
        "sku": "MYSKU",
        "quantity": 1,
        "due_date": 1532908800,
        "location_id": 9999,
        "location_name": "Warehouse",
        "created_at": 1527522957,
        "updated_at": 1527522957
      }
    }
    

    Bulk create or update inventory

    The bulk create/update allows you to pass an array of data. The current limit is set to 10.

    Example POST Request

    curl "https://us.evoapi.io/products/inventory/bulk" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '["data": {"sku": "MYSKU","quantity": 1,"location_id": 9999,"due_date":1532908800}]'
    

    JSON

    {
      "data": [
        {
          "sku": "MYSKU",
          "quantity": 1,
          "location_id": 9999,
          "due_date": 1532908800
        }
      ]
    }
    

    HTTP Request

    POST https://us.evoapi.io/products/inventory/bulk

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
            "sku": "MYSKU",
            "quantity": 1,
            "location_id": 9999,
            "due_date": 1532908800
          },
          "reason": "Location ID 9999 not found."
        }
      ]
    }
    

    List of Inventory Locations

    This endpoint retrieves all inventory locations.

    HTTP Request

    GET https://us.evoapi.io/products/inventory/locations

    curl "https://us.evoapi.io/products/inventory/locations" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 1,
      "data": [
        {
          "id": 1,
          "supplier_id": 1001,
          "name": "Dublin",
          "enabled": true,
          "created_at": 1513598438,
          "updated_at": 1513598438
        }
      ]
    }
    

    Attributes

    Attribute Description
    id integer The location id
    supplier_id integer The location supplier
    name string The location name
    enabled boolean The location status
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC).

    Query Parameters

    Parameter Description Example
    limit The number of roles you want. Default is 10 and max is 100. 10
    from_id The role id you want to start from. 1111122
    ids A list of ids you want to filter roles. 1111122,1111123,1111125
    name You can filter by the location name Dublin
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Pricing

    The pricing object

    Example Response

    {
      "id": 1,
      "name": "My Pricing Rule",
      "type_id": 3,
      "priority": 0,
      "band_priority": 0,
      "item_priority": 0,
      "category_priority": 0,
      "brand_priority": 0,
      "mailer_priority": 0,
      "quantity_priority": 0,
      "accounts": 0,
      "users": 2,
      "items": 9,
      "bands": 9,
      "categories": 9,
      "brands": 9,
      "visible": false,
      "cheapest": false,
      "auto_deletion": false,
      "from": 1517616000,
      "to": 1532131200,
      "enabled": true,
      "created_at": 1517484760,
      "updated_at": 1528736322
    }
    

    Attributes

    Attribute Description
    id integer The pricing rules id
    name string The pricing rules name
    type_id integer The pricing rules type
    priority integer The rule priority
    band_priority integer The band priority
    item_priority integer The item priority
    category_priority integer The category priority
    brand_priority integer The brand priority
    mailer_priority integer The mailer priority
    quantity_priority integer The quantity priority
    accounts integer The number of accounts linked (if any)
    users integer The number of users linked (if any)
    items integer The number of items linked (if any)
    bands integer The number of bands linked (if any)
    categories integer The number of categories linked (if any)
    brands integer The number of brands linked (if any)
    visible boolean Is the pricing rule visible
    cheapest boolean Is this the cheapest
    auto_deletion boolean Will this rule auto delete after to date
    from timestamp The starting date of this rule (Unix timestamp in UTC).
    to timestamp The ending date of this rule (Unix timestamp in UTC).
    enabled boolean Is this rule enabled
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the item was last updated (Unix timestamp in UTC).

    Pricing Type ID's

    ID Description
    0 Account(s)
    1 All Accounts
    2 Guests/Surfer (Unregistered)
    3 Users
    4 All Non-Account Users
    5 All Non-Account Users & Accounts (Registered)
    6 Global

    List all pricing rules

    curl "https://us.evoapi.io/pricing" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1,
        "data": [
            {
                "id": 1,
                "name": "My Pricing Rule",
                "type_id": 3,
                "priority": 0,
                "band_priority": 0,
                "item_priority": 0,
                "category_priority": 0,
                "brand_priority": 0,
                "mailer_priority": 0,
                "quantity_priority": 0,
                "accounts": 0,
                "users": 2,
                "items": 9,
                "bands": 9,
                "categories": 9,
                "brands": 9,
                "visible": false,
                "cheapest": false,
                "auto_deletion": false,
                "from": 1517616000,
                "to": 1532131200,
                "enabled": true,
                "created_at": 1517484760,
                "updated_at": 1528736322
            }
        ]
    }
    

    This endpoint retrieves all pricing rules.

    HTTP Request

    GET https://us.evoapi.io/pricing

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    name Get the pricing rule by name. My Pricing Rule
    type_id Filter by the type_id 1
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Update pricing

    You would use this request to update a pricing rule

    Example PUT Request

    curl "https://us.evoapi.io/pricing/pricing_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT - d '{ "name": "My Pricing Rule", "type_id": 3, "priority": 0, "band_priority": 2, "item_priority": 1, "category_priority": 3, "brand_priority": 4, "mailer_priority": 5, "quantity_priority": 6, "auto_deletion": false, "from": 3642636800, "to": 3642736800 }'
    

    JSON

    {
        "name": "My Pricing Rule",
      "type_id": 3,
      "priority": 0,
      "band_priority": 2,
      "item_priority": 1,
      "category_priority": 3,
      "brand_priority": 4,
      "mailer_priority": 5,
      "quantity_priority": 6,
      "auto_deletion": false,
      "from": 3642636800,
      "to": 3642736800
    }
    

    HTTP Request

    PUT https://us.evoapi.io/pricing/pricing_id

    Attributes

    Attribute Description
    name string The pricing rules name
    type_id integer The pricing rules type
    priority integer The rule priority
    band_priority integer The band priority
    item_priority integer The item priority
    category_priority integer The category priority
    brand_priority integer The brand priority
    mailer_priority integer The mailer priority
    quantity_priority integer The quantity priority
    auto_deletion boolean Will this rule auto delete after to date
    from timestamp The starting date of this rule (Unix timestamp in UTC).
    to timestamp The ending date of this rule (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Create pricing

    The request used in order to create a new pricing rule.

    Example POST Request

    curl "https://us.evoapi.io/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "name": "My Pricing Rule", "from": 1642636800, "to": 1642736800, "priority": 0, "auto_deletion": false, "type_id": 3, "item_priority": 1, "band_priority": 2, "category_priority": 3, "brand_priority": 4, "mailer_priority": 5, "quantity_priority": 6 }'
    

    JSON

    {
        "name": "My Pricing Rule",
      "type_id": 3,
      "priority": 0,
      "band_priority": 2,
      "item_priority": 1,
      "category_priority": 3,
      "brand_priority": 4,
      "mailer_priority": 5,
      "quantity_priority": 6,
      "auto_deletion": false,
      "from": 3642636800,
      "to": 3642736800
    }
    

    HTTP Request

    POST https://us.evoapi.io/pricing

    Attributes

    Attribute Description
    name string required The pricing rules name
    type_id integer required The pricing rules type
    priority integer The rule priority
    band_priority integer The band priority
    item_priority integer The item priority
    category_priority integer The category priority
    brand_priority integer The brand priority
    mailer_priority integer The mailer priority
    quantity_priority integer The quantity priority
    auto_deletion boolean Will this rule auto delete after to date
    from timestamp required The starting date of this rule (Unix timestamp in UTC).
    to timestamp required The ending date of this rule (Unix timestamp in UTC).
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "pricing": {
          "id": 24,
          "name": "My Pricing Rule",
          "type_id": 3,
          "priority": 0,
          "band_priority": 2,
          "item_priority": 1,
          "category_priority": 3,
          "brand_priority": 4,
          "mailer_priority": 5,
          "quantity_priority": 6,
          "accounts": 0,
          "users": 0,
          "items": 0,
          "bands": 0,
          "categories": 0,
          "brands": 0,
          "visible": false,
          "cheapest": false,
          "auto_deletion": false,
          "from": 3642624000,
          "to": 3642710400,
          "enabled": true,
          "created_at": 1528906489,
          "updated_at": 1528906489
      }
    }
    

    Delete a pricing rule

    Delete a pricing rule

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/pricing_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Empty the pricing rule

    This request allows you to delete all the items, bands, brands and categories from a pricing rule.

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/pricing_id/empty" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id/empty

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The pricing items object

    Example Response

    {
      "id": 3,
      "sku": "100-RT-112",
      "catalog_id": 1077,
      "supplier_id": 1034,
      "method_id": 1,
      "price": 200.50,
      "quantity": 1,
      "split_pack": false,
      "created_at": 1519142869,
      "updated_at": 1520249568
    }
    

    Attributes

    Attribute Description
    id integer The item rule id
    sku string The items sku
    catalog_id integer The catalog id
    supplier_id integer The supplier id
    method_id integer The method id
    price decimal The item price
    quantity integer The quantity
    split_pack boolean Is this split pack
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when this item was last updated (Unix timestamp in UTC).

    Pricing Items Method ID's

    ID Description
    1 Fixed Price
    2 % Discount off List Price
    3 % Markup
    4 % Margin
    5 Call for Price
    6 Quote Me

    List all pricing items

    curl "https://us.evoapi.io/pricing/pricing_id/items" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 42,
        "data": [
          {
            "id": 3,
            "sku": "100-RT-112",
            "catalog_id": 1077,
            "supplier_id": 1034,
            "method_id": 1,
            "price": 200.50,
            "quantity": 1,
            "split_pack": false,
            "created_at": 1519142869,
            "updated_at": 1520249568
          }
        ]
    }
    

    This endpoint retrieves all items.

    HTTP Request

    GET https://us.evoapi.io/pricing/pricing_id/items

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    sku Filter by the item sku 100-RT-112
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Create or Update Pricing Item

    This request will allow you to either create a new pricing item rule or update one.

    This is a bulk request meaning that you can update / create up to 150 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/pricing/pricing_id/items" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ { "type_id": 2, "catalog_id": 1000, "method_id": 1, "discount_band": "ZZ", "percentage": 20, "linked_id": 2631 } ] }'
    

    JSON

    {
      "data": [
        {
          "sku": "100-RT-112",
          "catalog_id": 1077,
          "supplier_id": 1034,
          "method_id": 1,
          "price": 200.50,
          "quantity": 1,
          "split_pack": false,
          "is_contract": true
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/pricing/pricing_id/items

    Attributes

    Attribute Description
    sku string required The items sku
    catalog_id integer The catalog id
    supplier_id integer The supplier id
    method_id integer required The method id
    price decimal required The item price
    quantity integer required The quantity
    split_pack boolean required Is this split pack
    is_contract boolean Set as a customer contract item. Set value to false if this is used for general pricing. Set as true on a smaller set of items should appear as contract items for this customer. A product with a Pricing Item record will make a private product visible regardless of the is_contract value. This field does not affect pricing but does effect inclusion of the item in the contract list view, contract icons on the product, and contract item widget in search results. Default value will be 'true' when creating or updating an item if no value is provided. Guidance is that no more that a few hundred prices per customer should be "contract items" to be a practical feature.
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
            "sku": "100-RT-112",
            "catalog_id": 9999,
            "supplier_id": 1034,
            "method_id": 1,
            "price": 200.50,
            "quantity": 1,
            "split_pack": false
          },
          "reason": "Product does not exist."
        }
      ]
    }
    

    Delete a Pricing Item Rule

    Delete a pricing item rule. If you would like to mass delete all items you can provide the string all.

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/pricing_id/items/id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id/items/id

    Mass Delete HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id/items/all

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The pricing matrix object

    Example Response

    {
        "id": 42,
        "type_id": 2,
        "catalog_id": 1000,
        "method_id": 1,
        "discount_band": "ZZ",
        "percentage": 20,
        "linked_id": 2631,
        "created_at": 1528723053,
        "updated_at": 1528723053
    }
    

    Attributes

    Attribute Description
    id integer The matrix id
    type_id integer The matrix type (Band, Brand, Category)
    catalog_id integer The catalog id
    method_id integer The method id
    discount_band integer The discount band
    percentage integer The percentage
    linked_id integer This is the id associated to the linked type. (type_id: 2 = brand_id, type_id: 3 = category_id) not needed for type_id: 1.
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when this item was last updated (Unix timestamp in UTC).

    Pricing Matrix Type ID's

    ID Description
    1 Band
    2 Brand
    3 Category

    Pricing Matrix Method ID's

    ID Description
    1 % Discount off List Price
    2 % Markup
    3 % Margin

    List all pricing matrices

    curl "https://us.evoapi.io/pricing/pricing_id/matrix" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 42,
        "data": [
          {
            "id": 42,
            "type_id": 2,
            "catalog_id": 1000,
            "method_id": 1,
            "discount_band": "ZZ",
            "percentage": 20,
            "linked_id": 2631,
            "created_at": 1528723053,
            "updated_at": 1528723053
          }
        ]
    }
    

    This endpoint retrieves all matrix items.

    HTTP Request

    GET https://us.evoapi.io/pricing/pricing_id/matrix

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    type_id Filter by the type_id 1
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Create or Update Pricing Matrix

    This request will allow you to either create a new pricing matrix rule or update one. The matrix rules cover Bands, Brands and Categories.

    This is a bulk request meaning that you can update / create up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/pricing/pricing_id/matrix" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ { "type_id": 2, "catalog_id": 1000, "method_id": 1, "discount_band": "ZZ", "percentage": 20, "linked_id": 2631 } ] }'
    

    JSON

    {
      "data": [
        {
          "type_id": 2,
          "catalog_id": 1000,
          "method_id": 1,
          "discount_band": "ZZ",
          "percentage": 20,
          "linked_id": 2631
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/pricing/pricing_id/matrix

    Attributes

    Attribute Description
    data array required The matrix array of objects
      type_id   integer required The matrix type (Band, Brand, Category)
      catalog_id   integer The catalog id
      method_id   integer required The method id
      discount_band   integer required if The discount band (This fields is required if type_id = 1)
      percentage   integer required The percentage
      linked_id   integer required if This is the id associated to the linked type. (type_id: 2 = brand_id, type_id: 3 = category_id) not needed for type_id: 1. (This fields is required if type_id = 2 or 3)
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
            "type_id": 2,
            "catalog_id": 1000,
            "method_id": 1,
            "discount_band": "ZZ",
            "percentage": 20,
            "linked_id": 00000000
          },
          "reason": "Linked ID 00000000 not found."
        }
      ]
    }
    

    Delete a Pricing Matrix Rule

    Delete a pricing matrix rule

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/pricing_id/matrix/matrix_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id/matrix/matrix_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The pricing users object

    Example Response

    {
        "id": 1000338,
        "customer_id": 1000003,
        "name": null,
        "email": "jh@evolution-software.net",
        "company": null,
        "created_at": 1528736357,
        "updated_at": 1528736357
    }
    

    Attributes

    Attribute Description
    id integer The user id
    customer_id string The customer id
    name integer The users name
    email integer The users email
    company integer The the users company
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the item was last updated (Unix timestamp in UTC).

    List all pricing users

    curl "https://us.evoapi.io/pricing/pricing_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000338,
        "data": [
            {
                "id": 1000338,
                "customer_id": 1000003,
                "name": "John Doe",
                "email": "john@doe.com",
                "company": "My Company",
                "created_at": 1528736357,
                "updated_at": 1528736357
            }
        ]
    }
    

    This endpoint retrieves all users.

    HTTP Request

    GET https://us.evoapi.io/pricing/pricing_id/users

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    email Filter by email. john@doe.com
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Add Users

    This request will allow you to add users to your pricing rule provided that type_id = 3

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/pricing/pricing_id/users" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ 1000338, 1000339, 1000340 ] }'
    

    JSON

    {
      "data": [
        1000338,
        1000339,
        1000340
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/pricing/pricing_id/users

    Attributes

    Attribute Description
    data array required An array of user id's
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": 1000338,
          "reason": "User does not exist"
        }
      ]
    }
    

    Delete a User

    Delete a user form a pricing rule

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/pricing_id/users/user_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id/users/user_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The pricing customers object

    Example Response

    {
      "id": 1000011,
      "name": "Admin User",
      "email": "admin@evolutionx.io",
      "company": "Evolution X",
      "created_at": 1527005605,
      "updated_at": 1527005605
    }
    

    Attributes

    Attribute Description
    id integer The customer id
    name integer The customers name
    email integer The customers email
    company integer The the customers company
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the item was last updated (Unix timestamp in UTC).

    List all pricing customers

    curl "https://us.evoapi.io/pricing/pricing_id/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000011,
        "data": [
            {
              "id": 1000011,
              "name": "Admin User",
              "email": "admin@evolutionx.io",
              "company": "Evolution X",
              "created_at": 1527005605,
              "updated_at": 1527005605
            }
        ]
    }
    

    This endpoint retrieves all customers.

    HTTP Request

    GET https://us.evoapi.io/pricing/pricing_id/customers

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    company Filter by the customers company name. Evolution X
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Add Customers

    This request will allow you to add customers to your pricing rule provided that type_id = 0

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/pricing/pricing_id/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ 1000011, 1000012, 1000013 ] }'
    

    JSON

    {
      "data": [
        1000011,
        1000012,
        1000013
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/pricing/pricing_id/customers

    Attributes

    Attribute Description
    data array required An array of user id's
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": 1000013,
          "reason": "Account does not exist"
        }
      ]
    }
    

    Delete a Customer

    Delete a customer form a pricing rule

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/pricing_id/customers/customer_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/pricing_id/customers/customer_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The Cost Price Object

    Example Response

    {
      "item_id": 1000000,
      "sku": "01003",
      "supplier_id": 1001,
      "cost": 99,
      "enabled": true,
      "created_at": 1534931351,
      "updated_at": 1534933950
    }
    

    Attributes

    Attribute Description
    item_id integer The item id
    sku string The item sku
    supplier_id integer The supplier id
    cost integer The item cost
    enabled boolean Is this cost enabled
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when this item was last updated (Unix timestamp in UTC).

    List All Cost Prices

    curl "https://us.evoapi.io/pricing/cost" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1000000,
        "data": [
          {
            "item_id": 1000000,
            "sku": "01003",
            "supplier_id": 1001,
            "cost": 99,
            "enabled": true,
            "created_at": 1534931351,
            "updated_at": 1534933950
          }
        ]
    }
    

    This endpoint retrieves all costs.

    HTTP Request

    GET https://us.evoapi.io/pricing/cost

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    sku Filter by the item sku 100-RT-112
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Create or Update Cost Price

    This request will allow you to either create a new cost price or update one.

    This is a bulk request meaning that you can update / create up to 200 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/pricing/cost" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data" : [ { "sku": "01003", "supplier_id": 1001, "cost" : 99, "enabled" : true } ] }'
    

    JSON

    {
        "data" : [
            {
                "sku": "01003",
                "supplier_id": 1001,
                "cost" : 99,
                "enabled" : true
            }
        ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/pricing/cost

    Attributes

    Attribute Description
    sku string required The item sku
    supplier_id integer required The supplier id
    cost integer required The item cost
    enabled boolean required Is this cost enabled
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
            "sku": "01003",
            "supplier_id": 1001,
            "cost" : 99,
            "enabled" : true
          },
          "reason": "Product does not exist."
        }
      ]
    }
    

    Delete a Cost Price

    Delete a cost price

    Example DELETE Request

    curl "https://us.evoapi.io/pricing/cost/item_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/pricing/cost/item_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Products

    The product list object

    Example Response

    {
      "id": 1000080,
      "sku": "MYPROD001",
      "title": "My Products Title",
      "catalog_id": 1008,
      "parent_catalog_id": null,
      "supplier_id": 1001,
      "brand_id": 1001,
      "manufacturer_id": null,
      "default_category": 123456,
      "health_flag": "Health Flag",
      "health_description": "This is the description",
      "price": 0,
      "item_weight": 0,
      "enabled": false,
      "visible": false,
      "is_visible": 0,
      "enabled_from": 1533299291,
      "enabled_to": 1533299291,
      "autoupdate": false,
      "created_at": 1515622074,
      "updated_at": 1533291895
    }
    

    Attributes

    Attribute Description
    id integer The products id
    sku string The products sku
    title string The products title
    catalog_id integer The catalog id
    parent_catalog_id integer Parent catalog id
    supplier_id integer Supplier id
    brand_id integer Brand id
    manufacturer_id integer Manufacturer id
    default_category integer Primary category id
    health_flag string The health flag
    health_description string The health flag description
    price number The products price
    item_weight integer The products weight
    enabled boolean Is this product enabled
    visible boolean Deprecated Is this product visible. Deprecated field, use is_visible field.
    is_visible integer Set a visible status code for the product. 0 is hidden from search, visible by URL. 1 is visible in search and url (standard item). 2 is hidden unless pricing item record exists for the current customer (private product). A product set as is_visible = 2 will be hidden by default unless item pricing exists for the customer.
    enabled_from timestamp The starting date of this product (Unix timestamp).
    enabled_to timestamp The ending date of this product (Unix timestamp).
    autoupdate boolean Is this product auto updated
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the product was last updated (Unix timestamp in UTC).

    List all products

    curl "https://us.evoapi.io/products" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1,
        "data": [
            {
              "id": 1000080,
              "sku": "MYPROD001",
              "title": "My Products Title",
              "catalog_id": 1008,
              "parent_catalog_id": null,
              "supplier_id": 1001,
              "brand_id": 1001,
              "manufacturer_id": null,
              "default_category": 123456,
              "health_flag": "Health Flag",
              "health_description": "This is the description",
              "price": 0,
              "item_weight": 0,
              "enabled": false,
              "visible": false,
              "is_visible": 0,
              "enabled_from": 1533299291,
              "enabled_to": 1533299291,
              "autoupdate": false,
              "created_at": 1515622074,
              "updated_at": 1533291895
            }
        ]
    }
    

    This endpoint retrieves all products.

    HTTP Request

    GET https://us.evoapi.io/products

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    sku Filter by the products sku or seperate by comma to filter by multiple. MYPROD001,MYPROD002
    catalog_id Get products by catalog. 1000
    supplier_id Get products by supplier 1000
    enabled True if you want to get only enabled items. true
    managed Filter by managed or custom store products true
    created_at Filter by creation date. (Unix timestamp in UTC). 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Create own products

    Create own products. Products created will be added to "Own Catalog".

    Example POST Request

    curl "https://us.evoapi.io/products" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{"title":"My Awesome Product","sku":"MAWSP-123","supplier_id":999,"enabled":true,"is_visible":1,"price":99.99,"cost_price":45.12,"pack":1}'
    

    JSON

    {
        "title": "My Awesome Product",
        "sku": "MAWSP-123",
        "supplier_id": 9999,
        "description": "Some product description",
        "brand_id": 9999,
        "manufacturer_id": 9999,
        "manufacturer_ref": "MAN1-MAWSP-123",
        "country_code": "IT",
        "default_category": 9999,
        "unspsc_code": null,
        "lead_time": null,
        "price": 99.99,
        "cost_price": 45.12,
        "map_price": 0,
        "pricing_matrix_1": null,
        "pricing_matrix_2": null,
        "minimum_order": 1,
        "maximum_order": null,
        "multiples_of": false,
        "minimum_override": null,
        "discount_exception": false,
        "pack": 1,
        "pack_uom": "EA",
        "pack_include": null,
        "weight": 0,
        "mass_unit": "kg",
        "depth": 0,
        "width": 0,
        "height": 0,
        "length": 0,
        "dimension_unit": "mm",
        "features": {
            "taxable": false,
            "hazmat": false,
            "freight": false,
            "green": false,
            "require_assembly": false,
            "recycled": false,
            "msds": false,
            "returnable": false,
            "freeshipping": false,
            "warranty": false,
            "warranty_description": null
        },
        "selling_points": [
            "Awesome product",
            "Collection of awesome products"
        ],
        "keywords": [
            "Awesome",
            "Free"
        ],
        "catalog_description": "Some catalog specific description",
        "global_description": null,
        "superseded_sku": null,
        "gtin": null,
        "returnable_code": null,
        "shipping_code": null,
        "catalog_page": null,
        "catalog_page_ref": null,
        "tax_class_id": "0",
        "image_name": "neogeo_1520512025.jpg",
        "image_path": "https://mycdn.com/product/images/",
        "image_thumbnail_name": "neogeo_1520512025.jpg",
        "image_thumbnail_path": "https://mycdn.com/product/images/thumbnails/",
        "seo": {
            "title": null,
            "description": null,
            "keywords": null
        },
        "enabled": true,
        "visible": true,
        "is_visible": 1,
        "enabled_from": 1535117355,
        "enabled_to": 1535117355,
    }
    

    HTTP Request

    POST https://us.evoapi.io/products

    Attributes

    Attribute Description
    title string required The product title
    sku string required The product SKU
    supplier_id integer required A valid supplier id
    description string The product description
    brand_id integer A valid brand id
    manufacturer_id integer A valid manufacturer id
    manufacturer_ref string The manufacturer reference
    country_code string A valid country code (ISO Alpha-2)
    default_category integer required A valid category id
    unspsc_code string UNSPSC code
    lead_time string Lead time
    price float required The product price
    cost_price float required The product cost price
    map_price float The product map price
    pricing_matrix_1 string Pricing matrix 1
    pricing_matrix_2 string Pricing matrix 2
    minimum_order integer Minimum order (default 1)
    maximum_order integer/null Maximum order. Greater than the minimum order
    multiples_of boolean Multiples of
    minimum_override boolean Minimum override
    discount_exception boolean Discount exception
    pack integer Pack size
    pack_uom string Pack UOM
    pack_include boolean Pack include
    weight float The product weight
    mass_unit string Mass unit (kg, lb). Required if the weight is provided.
    depth float The product depth
    width float The product width
    height float The product height
    length float The product length
    dimension_unit string Dimension unit (mm, in). Required if any of the measure of the product is provided.
    features object An object containing the product features
      taxable   boolean If taxable
      hazmat   boolean If hazmat
      freight   boolean If freight
      green   boolean If green
      require_assembly   boolean If require assembly
      recycled   boolean If recycled
      msds   boolean If msds
      returnable   boolean If returnable
      freeshipping   boolean If free shipping
      warranty   boolean If warranty
      warranty_description   string The warranty description
    selling_points array An array of bullet points
    keywords array An array of keywords (used when searching products)
    catalog_description string Catalog description
    global_description string Global description
    superseded_sku string The superseded SKU
    gtin string GTIN
    returnable_code string The product weight
    shipping_code string Shipping code
    catalog_page string Catalog page
    catalog_page_ref string Catalog page reference
    tax_class_id string The tax ID used by a tax integration to identify the type of product for tax purposes. If using Avalara Sales Tax integration this is the Avalara tax code.
    image_name string The product image name
    image_path string The product image path
    image_thumbnail_name string The product thumbnail name
    image_thumbnail_path string The product thumbnail path
    seo object An object containing the product features
      title   string Meta title
      description   string Meta description
      keywords   string Meta keywords
    enabled boolean required true if the product is enabled
    visible boolean Deprecated true if the product is visible. Deprecated field, use is_visible field.
    is_visible integer required Set a visible status code for the product. 0 is hidden from search, visible by URL. 1 is visible in search and url (standard item). 2 is hidden unless pricing item record exists for the current customer (private product). A product set as is_visible = 2 will be hidden by default unless item pricing exists for the customer.
    enabled_from integer Enabled from date (Unix timestamp)
    enabled_to integer Enabled to date (Unix timestamp)
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "product": {
            "id": 999999999,
            "title": "My Awesome Product",
            "slug": "my-awesome-sku",
            "sku": "MAWSP-123",
            "supplier_id": 9999,
            "supplier": "Supplier name",
            "catalog_id": 1000,
            "catalog": "Own Catalog",
            "description": "Some product description",
            "brand_id": 9999,
            "brand": "Brand name",
            "manufacturer_id": 9999,
            "manufacturer": "Manufacturer name",
            "manufacturer_ref": "MAN1-MAWSP-123",
            "country_code": "IT",
            "unspsc_code": null,
            "lead_time": null,
            "price": 99.99,
            "cost_price": 45.12,
            "map_price": 0,
            "pricing_matrix_1": null,
            "pricing_matrix_2": null,
            "minimum_order": 1,
            "maximum_order": null,
            "multiples_of": false,
            "minimum_override": null,
            "discount_exception": false,
            "pack": 1,
            "pack_uom": "EA",
            "pack_include": null,
            "weight": 0,
            "mass_unit": "kg",
            "depth": 0,
            "width": 0,
            "height": 0,
            "length": 0,
            "dimension_unit": "mm",
            "features": {
                "taxable": false,
                "hazmat": false,
                "freight": false,
                "green": false,
                "require_assembly": false,
                "recycled": false,
                "msds": false,
                "returnable": false,
                "freeshipping": false,
                "warranty": false,
                "warranty_description": null
            },
            "selling_points": [
                "Awesome product",
                "Collection of awesome products"
            ],
            "catalog_description": "Some catalog specific description",
            "global_description": null,
            "layout": null,
            "superseded_sku": null,
            "gtin": null,
            "returnable_code": null,
            "shipping_code": null,
            "catalog_page": null,
            "catalog_page_ref": null,
            "tax_class_id": "0",
            "categories": [
                {
                    "id": 9999,
                    "name": "Category name"
                }
            ],
            "media": {
                "image": "neogeo_1520512025.jpg",
                "image_path": "https://mycdn.com/product/images/",
                "image_thumbnail": "neogeo_1520512025.jpg",
                "image_thumbnail_path": "https://mycdn.com/product/images/thumbnails/",
                "additional_images": [],
                "videos": [],
                "documents": [],
                "sds": []
            },
            "attributes": [],
            "relationships": {
                "also_consider": [],
                "supplies_accessories": [],
                "recommendations": []
            },
            "keywords": [
                "Awesome",
                "Free"
            ],
            "labels": [],
            "catalogs": [
                {
                    "id": 1000,
                    "name": "Own Catalog"
                }
            ],
            "seo": {
                "title": null,
                "description": null,
                "keywords": null
            },
            "enabled": true,
            "visible": true,
            "is_visible": 1,
            "enabled_from": 1535117355,
            "enabled_to": 1535117355,
            "created_at": 1519730048,
            "updated_at": 1535031646
        }
    }
    

    Update products

    Update products.

    Example PUT Request

    curl "https://us.evoapi.io/products/999999999" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d '{"title":"My Updated Title"}'
    

    JSON

    {
        "title": "My Awesome Product",
    }
    

    HTTP Request

    PUT https://us.evoapi.io/products/product_id

    Attributes

    You can update any of the attributes referenced in product creation. You can pass only the attributes you want to update. The response is a JSON equal to the one returned on product creation.

    Query Parameters

    Parameter Description Example
    catalog_id The product catalog number. Default is 1000 if not specified 1000

    Viewing A Product

    Example Response

    HTTP Request

    GET https://us.evoapi.io/products/product_id?catalog_id=catalog_id&supplier_id=supplier_id

    {
        "status": "success",
        "product": {
            "id": 1000080,
            "title": "My Products Title",
            "slug": "my-products-title",
            "sku": "MYPROD001",
            "supplier_id": 1001,
            "supplier": "My Supplier",
            "catalog_id": 1008,
            "catalog": "Own Catalog",
            "description": "My products description",
            "brand_id": 1005,
            "brand": "My Brand",
            "manufacturer_id": null,
            "manufacturer": null,
            "manufacturer_ref": null,
            "country_code": "US",
            "unspsc_code": null,
            "lead_time": null,
            "health_flag": "Health Flag",
            "health_description": "This is the description",
            "price": 105.00,
            "cost_price": 80.00,
            "map_price": 0,
            "pricing_matrix_1": null,
            "pricing_matrix_2": null,
            "minimum_order": 5,
            "maximum_order": 10,
            "multiples_of": false,
            "minimum_override": {
                "minimum": 10,
                "maximum": 20,
                "multiples_of": true
            },
            "discount_exception": false,
            "pack": 0,
            "pack_uom": null,
            "pack_include": null,
            "weight": 0,
            "mass_unit": null,
            "depth": 0,
            "width": 0,
            "height": 0,
            "length": 0,
            "dimension_unit": null,
            "features": {
                "taxable": false,
                "hazmat": false,
                "freight": false,
                "green": false,
                "require_assembly": false,
                "recycled": false,
                "msds": false,
                "returnable": false,
                "freeshipping": false,
                "warranty": false,
                "warranty_description": null,
                "enable_attachment_upload": 0
            },
            "selling_points": [
                {
                    "id": 1000387,
                    "value": "Can be used on taps, sinks, worktops, toilets, urinals, showers and tiles",
                }
            ],
            "catalog_description": "<p>My catalog description</p>",
            "global_description": "<p>My global description</p>",
            "layout": null,
            "superseded_sku": null,
            "gtin": null,
            "returnable_code": null,
            "shipping_code": null,
            "catalog_page": null,
            "catalog_page_ref": null,
            "tax_class_id": "0",
            "categories": [
                {
                    "id": 1004115,
                    "name": "Desks"
                }
            ],
            "media": {
                "image": "MYPROD001.jpg",
                "image_path": "https://cdn3.evostore.io/productimages/",
                "image_thumbnail": "MYPROD001.jpg",
                "image_thumbnail_path": "https://cdn3.evostore.io/productimages/",
                "additional_images": [
                    {
                        "id": 1261628,
                        "image": "MYPROD001-Lrg.jpg",
                        "image_path": "https://evocdn.io/dealer/1000/catalog/product/images/",
                        "image_thumbnail": "MYPROD001-Lrg.jpg",
                        "image_thumbnail_path": "https://evocdn.io/dealer/1000/catalog/product/images/thumbnails/",
                        "created_at": 1533121236,
                        "updated_at": 1533121236
                    }
                ],
                "videos": [
                    {
                        "id": 3915127,
                        "value": "https://www.youtube.com/watch?v=xxx-xxxxxx",
                    }
                ],
                "documents": [
                    {
                        "id": 2310700,
                        "value": "https://cdn3.evostore.io/documents/MYPROD001.pdf",
                    }
                ],
                "sds": []
            },
            "attributes": [
                {
                    "id": 7522368,
                    "attribute_id": 144508,
                    "attribute_name": "My Attribute",
                    "attribute_value_id": 144508,
                    "attribute_value_name": "My Attribute Value",
                    "filterable": true,
                    "created_at": 1526918939,
                    "updated_at": 1526918939
                }
            ],
            "relationships": {
                "also_consider": [
                    {
                        "id": 1000098,
                        "catalog_id": 1008,
                        "supplier_id": 1001,
                        "title": "My Product",
                        "sku": "MYSKU000",
                        "created_at": 1515623352,
                        "updated_at": 1515623352
                    }
                ],
                "supplies_accessories": [
                    {
                        "id": 1005619,
                        "catalog_id": 1008,
                        "supplier_id": 1001,
                        "title": "My Product",
                        "sku": "MYSKU000",
                        "created_at": 1515623441,
                        "updated_at": 1515623441
                    }
                ],
                "recommendations": [
                    {
                        "id": 1005628,
                        "catalog_id": 1008,
                        "supplier_id": 1001,
                        "title": "My Product",
                        "sku": "MYSKU000",
                        "created_at": 1515623441,
                        "updated_at": 1515623441
                    }
                ]
            },
            "keywords": [
                "my first keyword",
                "my second keyword"
            ],
            "labels": [
                {
                    "id": 66,
                    "name": "B2B",
                    "type": "product"
                }
            ],
            "catalogs": [
                {
                    "id": 1001,
                    "name": "Vow ePlus UK October 17"
                }
            ],
            "seo": {
                "title": "Title",
                "description": "Description",
                "keywords": "Keywords"
            },
            "enabled": false,
            "visible": false,
            "is_visible": 0,
            "enabled_from": 1533300468,
            "enabled_to": 1533300468,
            "created_at": 1515622074,
            "updated_at": 1533291895
        }
    }
    

    Attributes

    Attribute Description
    id integer The id
    title string The title
    slug string The product slug
    sku string The sku
    supplier_id integer The supplier id
    supplier supplier The supplier name
    catalog_id integer The catalog id
    catalog string The catalog name
    description string The description
    brand_id integer The brand id
    brand string The brand name
    manufacturer_id string The manufacturer ID
    manufacturer string The manufacturer name
    manufacturer_ref string The manufacturer sku
    country_code string The ISO 2 country code
    unspsc_code string The unspsc code
    lead_time string The lead time
    health_flag string The health flag
    health_description string The health flag description
    price number The price
    cost_price number The cost price
    map_price number The minimum advertisable price
    pricing_matrix_1 string The Pricing Matrix / Band 1
    pricing_matrix_2 string The Pricing Matrix / Band 2
    minimum_order integer The Minimum Order Quantity
    maximum_order integer The Maximum Order Quantity
    multiples_of boolean Multiples of
    minimum_override object Override Minimum and Maximum Order Quantities
      minimum   integer The Minimum Order Quantity override
      maximum   integer The Maximum Order Quantity override
      multiples_of   boolean Multiples of override
    discount_exception boolean Is there a discount exception
    pack integer The pack number
    pack_uom integer The pack uom
    pack_include string The pack includes
    weight integer The weight
    mass_unit string The mass unit
    depth integer The depth
    width integer The width
    height integer The height
    length integer The length
    dimension_unit string The dimension unit
    features object The features object
      taxable boolean Taxable
      hazmat boolean Contains hazardous material
      freight boolean Non standard shipping
      green boolean Eco Friendly
      require_assembly boolean Requires assembly
      recycled boolean Recycled
      msds boolean Safety Data Sheet
      returnable boolean Returnable
      freeshipping boolean Eligible for free shipping
      warranty boolean Warranty included
      warranty_description string Warranty description
      enable_attachment_upload boolean Enable Attachment Upload
    selling_points array List of selling points
      id integer Selling point id
      value string The selling point
    catalog_description string Catalog description
    global_description string Global description
    layout integer The layout id
    superseded_sku string Superseded SKU
    gtin string Global Trade Item Number
    returnable_code string Returnable Code
    shipping_code string Shipping Code
    catalog_page string Catalog Page Number
    catalog_page_ref string Catalog Page Reference
    tax_class_id string The tax ID used by a tax integration to identify the type of product for tax purposes. If using Avalara Sales Tax integration this is the Avalara tax code.
    categories array Category array
      id string Category ID
      name string Category Name
    media object The media object
      image string Image filename
      image_path string Image path
      image_thumbnail string Thumbnail image filename
      image_thumbnail_path string Thumbanil image path
      additional_images array Additional image list
        id    integer Image id
        image    string Image filename
        image_path    string Image path
        image_thumbnail    string Thumbnail image name
        image_thumbnail_path    string Thumbnail image path
        created_at    timestamp The creation date (Unix timestamp in UTC).
        updated_at    timestamp The updated date (Unix timestamp in UTC).
      videos array List of Videos
        id    integer Video id
        value    string Video url
      documents array List of documents
        id    integer Document id
        value    string Document url
      sds array Safty data sheet list
        id    integer sds id
        value    string sds url
    attributes array Array of attribute objects
      id  integer Attribute Relationship Id
      attribute_id  integer Attribute id
      attribute_name  integer Attribute name
      attribute_value_id  integer Attribute value id
      attribute_value_name  integer Attribute value name
      filterable   integer Is the attribute filterable on the storefront
      created_at   timestamp The creation date (Unix timestamp in UTC).
      updated_at  timestamp The date when the attribute relationship was last updated (Unix timestamp in UTC).
    relationships object Product relationship object
      also_consider array Array of products
        id    integer Product Id
        catalog_id    integer Product Catalog ID
        supplier_id    integer Product Supplier ID
        title    integer Product Title
        sku    string Product SKU
        created_at    timestamp The creation date (Unix timestamp in UTC).
        updated_at    timestamp The updated date (Unix timestamp in UTC).
      supplies_accessories array Array of products
        id    integer Product Id
        catalog_id    integer Product Catalog ID
        supplier_id    integer Product Supplier ID
        title    integer Product Title
        sku    string Product SKU
        created_at    timestamp The creation date (Unix timestamp in UTC).
        updated_at    timestamp The updated date (Unix timestamp in UTC).
      recommendations array Array of products
        id    integer Product Id
        catalog_id    integer Product Catalog ID
        supplier_id    integer Product Supplier ID
        title    integer Product Title
        sku    string Product SKU
        created_at    timestamp The creation date (Unix timestamp in UTC).
        updated_at    timestamp The updated date (Unix timestamp in UTC).
    keywords array Array of keywords
    labels array Array of labels
      id integer Label ID
      name string Label Name
      type string Label Type (product, tax)
    catalogs array Array of catalogs
      id integer Catalog ID
      name string Catalog Name
    seo object SEO object
      title string Product SEO Title
      description string Product SEO Description
      keywords string Product SEO Keywords
    enabled boolean Is this product enabled
    visible boolean Deprecated Is this product visible. Deprecated field, use is_visible field.
    is_visible integer Set a visible status code for the product. 0 is hidden from search, visible by URL. 1 is visible in search and url (standard item). 2 is hidden unless pricing item record exists for the current customer (private product). A product set as is_visible = 2 will be hidden by default unless item pricing exists for the customer.
    enabled_from timestamp The starting date of this product (Unix timestamp).
    enabled_to timestamp The ending date of this product (Unix timestamp).
    created_at timestamp The creation date (Unix timestamp).
    updated_at timestamp The date when the product was last updated (Unix timestamp).

    Query Parameters

    Parameter Description Example
    catalog_id required The product catalog number. 1000
    supplier_id required The products supplier number. 1000

    Delete A Product

    Delete A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Create Child Product

    Create a child product by providing the item_id and parent catalog_id. When you create a child product we copy all of the parent's values unless new ones are outlined in the post request.

    Example POST Request

    curl "https://us.evoapi.io/products/item_id/child-of/parent_catalog_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X POST -d '{ "catalog_id": 1003, "title": "My Child Product", }'
    

    JSON

    {
      "catalog_id": 1003,
      "title": "My Child Product",
    }
    

    HTTP Request

    POST https://us.evoapi.io/products/item_id/child-of/parent_catalog_id

    Attributes

    Attribute Description
    catalog_id string required The child's catalog_id
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "product": {
            "id": 999999999,
            "title": "My Child Product",
            "slug": "my-awesome-sku",
            "sku": "MAWSP-123",
            "supplier_id": 9999,
            "supplier": "Supplier name",
            "catalog_id": 1003,
            "catalog": "Own Catalog",
            "description": "Some product description",
            "brand_id": 9999,
            "brand": "Brand name",
            "manufacturer_id": 9999,
            "manufacturer": "Manufacturer name",
            "manufacturer_ref": "MAN1-MAWSP-123",
            "country_code": "IT",
            "unspsc_code": null,
            "lead_time": null,
            "price": 99.99,
            "cost_price": 45.12,
            "map_price": 0,
            "pricing_matrix_1": null,
            "pricing_matrix_2": null,
            "minimum_order": 1,
            "maximum_order": null,
            "multiples_of": false,
            "minimum_override": null,
            "discount_exception": false,
            "pack": 1,
            "pack_uom": "EA",
            "pack_include": null,
            "weight": 0,
            "mass_unit": "kg",
            "depth": 0,
            "width": 0,
            "height": 0,
            "length": 0,
            "dimension_unit": "mm",
            "features": {
                "taxable": false,
                "hazmat": false,
                "freight": false,
                "green": false,
                "require_assembly": false,
                "recycled": false,
                "msds": false,
                "returnable": false,
                "freeshipping": false,
                "warranty": false,
                "warranty_description": null
            },
            "selling_points": [
                "Awesome product",
                "Collection of awesome products"
            ],
            "catalog_description": "Some catalog specific description",
            "global_description": null,
            "layout": null,
            "superseded_sku": null,
            "gtin": null,
            "returnable_code": null,
            "shipping_code": null,
            "catalog_page": null,
            "catalog_page_ref": null,
            "tax_class_id": "0",
            "categories": [
                {
                    "id": 9999,
                    "name": "Category name"
                }
            ],
            "media": {
                "image": "neogeo_1520512025.jpg",
                "image_path": "https://mycdn.com/product/images/",
                "image_thumbnail": "neogeo_1520512025.jpg",
                "image_thumbnail_path": "https://mycdn.com/product/images/thumbnails/",
                "additional_images": [],
                "videos": [],
                "documents": [],
                "sds": []
            },
            "attributes": [],
            "relationships": {
                "also_consider": [],
                "supplies_accessories": [],
                "recommendations": []
            },
            "keywords": [
                "Awesome",
                "Free"
            ],
            "labels": [],
            "catalogs": [
                {
                    "id": 1000,
                    "name": "Own Catalog"
                }
            ],
            "seo": {
                "title": null,
                "description": null,
                "keywords": null
            },
            "enabled": true,
            "visible": true,
            "is_visible": 1,
            "enabled_from": 1535117355,
            "enabled_to": 1535117355,
            "created_at": 1519730048,
            "updated_at": 1535031646
        }
    }
    

    The Attribute List Object

    Example Response

    {
      "id": 100000,
      "supplier_id": 0,
      "name": "My Attribute Name",
      "sort_order": 1,
      "created_at": 1515621369,
      "updated_at": 1515623109
    }
    

    Attributes

    Attribute Description
    id integer The attribute id
    supplier_id integer The supplier id
    name string The attribute name
    sort_order integer The sort order
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when last updated (Unix timestamp in UTC).

    List All Attributes

    curl "https://us.evoapi.io/products/attributes" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 42,
        "data": [
          {
            "id": 100000,
            "supplier_id": 0,
            "name": "My Attribute Name",
            "sort_order": 1,
            "created_at": 1515621369,
            "updated_at": 1515623109
          }
        ]
    }
    

    This endpoint retrieves all product attributes.

    HTTP Request

    GET https://us.evoapi.io/products/attributes

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    name Filter by name My Attribute
    enabled True if you want to get only enabled records. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    The Attribute Value List Object

    Example Response

    {
      "id": 100000,
      "supplier_id": 0,
      "value": "My Attribute Value",
      "sort_order": 1,
      "created_at": 1515621369,
      "updated_at": 1515623109
    }
    

    Attributes

    Attribute Description
    id integer The attribute id
    supplier_id integer The supplier id
    value string The attribute value
    sort_order integer The sort order
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when last updated (Unix timestamp in UTC).

    List All Attribute Values

    curl "https://us.evoapi.io/products/attribute-values" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 42,
        "data": [
          {
            "id": 100000,
            "supplier_id": 0,
            "value": "My Attribute Value",
            "sort_order": 1,
            "created_at": 1515621369,
            "updated_at": 1515623109
          }
        ]
    }
    

    This endpoint retrieves all product attribute values.

    HTTP Request

    GET https://us.evoapi.io/products/attribute-values

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    value Filter by value My Attribute Value
    enabled True if you want to get only enabled records. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Add Attributes To Product

    This request will allow you to add attributes to a Non Managed product.

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/products/product_id/attributes?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "attribute_id": 100002, "attribute_value_id" : 100002, "filterable" : true, }'
    

    JSON

    {
      "data": [
        {
          "attribute_id": 100002,
          "attribute_value_id" : 100002,
          "filterable" : true,
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/products/product_id/attributes?catalog_id=catalog_id&supplier_id=supplier_id

    Attributes

    Attribute Description
    data array required An array of attribute objects
      attribute_id   integer required The attribute id
      attribute_value_id   integer required The attribute value id
      filterable   boolean Is this attribute filterable
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
            "data": {
                "attribute_id": 100002,
                "attribute_value_id": 100002,
                "filterable": true
            },
            "reason": "Product either does not exist or is managed"
        }
      ]
    }
    

    Delete An Attribute From A Product

    Delete An Attribute From A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id/relationships/relationship_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id/relationships/relationship_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Add Categories To Product

    This request will allow you to add categories to a product.

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/products/product_id/categories?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [1000000, 1000001] }'
    

    JSON

    {
      "data": [1000000, 1000001]
    }
    

    HTTP Request

    POST https://us.evoapi.io/products/product_id/categories?catalog_id=catalog_id&supplier_id=supplier_id

    Attributes

    Attribute Description
    data array required An array of category id's.
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          {
            "data": 999999,
            "reason": "Category does not exist"
          }
        }
      ]
    }
    

    Delete A Category From A Product

    Delete A Category From A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id/categories/category_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id/categories/category_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Add Labels To Product

    This request will allow you to add labels to a product of type tax or product.

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/products/product_id/labels?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [1, 2] }'
    

    JSON

    {
      "data": [1, 2]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/products/product_id/labels?catalog_id=catalog_id&supplier_id=supplier_id

    Attributes

    Attribute Description
    data array required An array of label id's, these labels must of either 'tax' or 'product' type.
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": 99999,
          "reason": "The label does not exist or is not of 'tax' or 'product' type"
        }
      ]
    }
    

    Delete A Label From A Product

    Delete A Label From A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id/labels/label_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id/labels/label_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    The product feed object

    Example Response

    {
        "id": 37,
        "product_group_id": 37,
        "status_id": 0,
        "feed_type": "commerceconnector",
        "label": "Default feed",
        "store_url": "https://mywebsite.com",
        "country": "GB",
        "currency_code": "GBP",
        "tax_rate": "10.0000",
        "is_published": false,
        "default_fields": {
            "shipping_cost": 10,
            "vat_shipping_cost": 15,
            "delivery_time": 2
        },
        "is_global": true,
        "enabled": true,
        "created_at": 1524054047,
        "updated_at": 1524055673,
        "files": [
            {
                "filename": "feed_item-1000199-1594376864.csv",
                "url": "https://eu.evocdn.io/dealer/1000/feeds/custom/feed_item-1000199-1594376864.csv",
                "created_at": 1594376865
            }
        ]
    }
    

    Attributes

    Attribute Description
    id integer The feed id
    product_group_id integer The product group id.
    status_id integer The feed status. 0: New Feed. 1: feed Initiated. 2: In Progress. 3: Completed.
    feed_type string The feed type. It can have one of these 3 values: csv, googlemerchant, commerceconnector.
    label string The feed label.
    store_url string The store url.
    country string The store country.
    currency_code string The store currency code.
    tax_rate number The store tax rate.
    is_published boolean Is the feed being published (pushed for google merchant). Setting it to true will override the generate_file value and will force generate a new file. (For csv type, it will always be false).
    default_fields object An object with the feed default fields.
      shipping_cost   number Commerce connector field for shipping cost.
      vat_shipping_cost   number Commerce connector field for vat shipping cost.
      delivery_time   number Commerce connector field for delivery time.
      google_category   string Google merchant field for Google Category (Click here to see the google taxonomy).
    is_global boolean Is the product group pricing global.
    enabled boolean Is this feed active.
    created_at timestamp The feed creation date (Unix timestamp in UTC).
    updated_at timestamp The date when the order was last updated (Unix timestamp in UTC).
    files array An array with the feed file objects (Commerce connector feeds have only one feed file object).
      filename   string The file name.
      url   string The file download link.
      created_at   timestamp The date when the file was generated (Unix timestamp in UTC).

    List all product feeds

    curl "https://us.evoapi.io/products/feeds" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": null,
        "data": [
            {
                "id": 1000122,
                "product_group_id": 125,
                "status_id": 3,
                "feed_type": "commerceconnector",
                "label": "My feed",
                "store_url": "https://www.mywebsite.com",
                "country": "GB",
                "currency_code": "GBP",
                "tax_rate": "10.0000",
                "is_published": false,
                "default_fields": {
                    "shipping_cost": 4,
                    "vat_shipping_cost": 15,
                    "delivery_time": 2
                },
                "is_global": true,
                "enabled": true,
                "created_at": 1594374149,
                "updated_at": 1594374281,
                "files": [
                    {
                        "filename": "feed_item-1000122.csv",
                        "url": "https://us.evocdn.io/dealer/1153/feeds/feed_item-1000122.csv",
                        "created_at": 1594374185
                    }
                ]
            }
        ]
    
    }
    

    This endpoint retrieves all product feeds.

    HTTP Request

    GET https://us.evoapi.io/products/feeds

    Query Parameters

    Parameter Description Example
    limit The number of product feeds you want. Default is 10 and max is 100. 10
    from_id The product feed id you want to start from. 1111122
    ids A list of ids you want to filter product feeds. 1111122,1111123,1111125
    created_at The creation date of the product feeds. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the product feeds. Same as the rule above. 1516693636

    Create product feed

    Example POST Request

    curl "https://us.evoapi.io/products/feeds" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
      -X POST -d '{"label":"EvolutionX Feed","product_group_id":125,"feed_type":"commerceconnector","default_fields": { "shipping_cost": 10.4, "vat_shipping_cost": 11.3,
                  "delivery_time": 5},"enabled": true,"is_global": true,"is_published": true,"generate_file": true'
    

    JSON

    {
        "label": "EvolutionX Feed",
        "product_group_id": 125,
        "feed_type": "commerceconnector",
        "default_fields": {
            "shipping_cost": 10.4,
            "vat_shipping_cost": 11.3,
            "delivery_time": 5
        },
        "enabled": true,
        "is_global": true,
        "is_published": true,
        "generate_file": true
    }
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "feed": {
            "id": 1000242,
            "product_group_id": 125,
            "status_id": null,
            "feed_type": "commerceconnector",
            "label": "EvolutionX Feed",
            "store_url": "https://www.mywebsite.com",
            "country": "GB",
            "currency_code": "GBP",
            "tax_rate": "10.0000",
            "is_published": false,
            "default_fields": {
                "shipping_cost": 10.4,
                "vat_shipping_cost": 11.3,
                "delivery_time": 5
            },
            "is_global": true,
            "enabled": true,
            "created_at": 1594633255,
            "updated_at": 1594633255,
        }
    }
    

    HTTP Request

    POST https://us.evoapi.io/products/feeds

    Attributes

    Attribute Description
    label string required The product feed label
    product_group_id integer The product group id
    feed_type string required The feed type. It can have one of these 3 values: csv, googlemerchant, commerceconnector.
    is_published boolean *required Is the feed being published (pushed for google merchant). Setting it to true will override the generate_file value and will force generate a new file. *Not required for csv type.
    default_fields object An object with the feed default fields.
      shipping_cost   number Commerce connector field for shipping cost. *Required for commerce connector feeds.
      vat_shipping_cost   number Commerce connector field for vat shipping cost. *Required for commerce connector feeds.
      delivery_time   number Commerce connector field for delivery time. *Required for commerce connector feeds.
      google_category   string Google merchant field for Google Category (Click here to see the google taxonomy).
    is_global boolean required Is the product group pricing global.
    enabled boolean required Is this feed active.
    generate_file boolean Generate the file for this feed.

    Update product feed

    Example PUT Request

    curl "https://us.evoapi.io/products/feeds/feed_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT -d "label=New Feed&product_group_id=142"
    

    JSON

    {
        "label": "New Feed",
        "product_group_id": 142,
    }
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "feed": {
            "id": 1000242,
            "product_group_id": 142,
            "status_id": null,
            "feed_type": "commerceconnector",
            "label": "New Feed",
            "store_url": "https://www.mywebsite.com",
            "country": "GB",
            "currency_code": "GBP",
            "tax_rate": "10.0000",
            "is_published": false,
            "default_fields": {
                "shipping_cost": 10.4,
                "vat_shipping_cost": 11.3,
                "delivery_time": 5
            },
            "is_global": true,
            "enabled": true,
            "created_at": 1594633255,
            "updated_at": 1594633255,
        }
    }
    

    Update product feed by providing the id and fields you wish to update.

    HTTP Request

    PUT https://us.evoapi.io/products/feeds/feed_id

    Attributes

    Attribute Description
    label string The product feed label
    product_group_id integer The product group id
    is_published boolean Is the feed being published (pushed for google merchant). Setting it to true will override the generate_file value and will force generate a new file. *Not required for csv type.
    default_fields object An object with the feed default fields.
      shipping_cost   number Commerce connector field for shipping cost. *Required for commerce connector feeds.
      vat_shipping_cost   number Commerce connector field for vat shipping cost. *Required for commerce connector feeds.
      delivery_time   number Commerce connector field for delivery time. *Required for commerce connector feeds.
      google_category   string Google merchant field for Google Category (Click here to see the google taxonomy).
    is_global boolean Is the product group pricing global.
    enabled boolean Is this feed active.
    generate_file boolean Generate the file for this feed.

    Delete a product feed

    Example DELETE Request

    curl "https://us.evoapi.io/products/feeds/feed_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Delete a product feed

    HTTP Request

    DELETE https://us.evoapi.io/products/feeds/feed_id

    Add Media Content To Product

    This request will allow you to add video, documents and sds content types.

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/products/product_id/media/content?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ { "type_id": 3, "value" : "https://www.youtube.com/xxxxxxxx" } ] }'
    

    JSON

    {
      "data": [
        {
          "type_id": 3,
          "value" : "https://www.youtube.com/xxxxxxxx"
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/products/product_id/media/content?catalog_id=catalog_id&supplier_id=supplier_id

    Attributes

    Attribute Description
    data array required An array of content objects
      type_id   integer   required The content type (sds, video, document)
      value   string   required The content value

    Media Type ID's

    ID Description
    2 SDS
    3 Videos
    5 Documents
    
    

    There are 3 different responses you can get back:

    Example JSON Response

    {
      "status": "success"
    }
    

    Delete Content From A Product

    Delete Content From A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id/media/content/content_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id/media/content/content_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Add Additional Images To Product

    This request will allow you to add additional images to the product

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/products/product_id/media/images?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{{ "data": [ { "image": "my-products-image.jpg", "image_path" : "https://mywebsite.com/product-images/", } ] }'
    

    JSON

    {
      "data": [
        {
          "image": "my-products-image.jpg",
          "image_path" : "https://mywebsite.com/product-images/"
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/products/product_id/media/images?catalog_id=catalog_id&supplier_id=supplier_id

    Attributes

    Attribute Description
    data array required An array of image objects
      image   string required This is the image name with extension
      image_path   string The image path without trailing filename, if left empty this will be populated with the stores CDN URL and default path to product images /dealer/store_id/catalog/product/images/

    Accepted Image Extensions

    ID Description
    1 jpg
    2 jpeg
    3 png
    4 gif
    5 tiff
    6 bmp
    
    

    The are 3 different responses you can get back:

    Example JSON Response

    {
      "status": "success"
    }
    

    Delete Additional Image From A Product

    Delete Additional Image From A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id/media/images/additional_image_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id/media/images/additional_image_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Add Relationships To Product

    This request will allow you to add relationships to product.

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/products/product_id/relationships?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ { "item_id": 1000000, "catalog_id" : 1003, "supplier_id" : 1000, "type_id": 1 } ] }'
    

    JSON

    {
      "data": [
        {
          "item_id": 1000000,
          "catalog_id" : 1003,
          "supplier_id" : 1000,
          "type_id": 1
        }
      ]
    }
    

    HTTP Request

    POST https://us.evoapi.io/products/product_id/relationships?catalog_id=catalog_id&supplier_id=supplier_id

    Attributes

    Attribute Description
    data array required An array of content objects
      item_id   integer required The products ID you wish to link
      catalog_id   integer required The products catalog ID
      supplier_id   integer required The products supplier ID
      type_id   integer required The relationship type (Also Consider, Recomendations, Supplies & Accessories)

    Relationship Type ID's

    ID Description
    1 Also Consider
    2 Recomendations
    3 Supplies & Accessories
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
              "item_id": 9999999,
              "catalog_id": 1003,
              "type_id": 1
          },
          "reason": "Product does not exist"
        }
      ]
    }
    

    Delete Relationships From A Product

    Delete Relationships From A Product

    Example DELETE Request

    curl "https://us.evoapi.io/products/product_id/media/images/additional_image_id?catalog_id=catalog_id&supplier_id=supplier_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    JSON

    HTTP Request

    DELETE https://us.evoapi.io/products/product_id/media/images/additional_image_id?catalog_id=catalog_id&supplier_id=supplier_id

    The above command returns JSON structured like this:

    {
      "status": "success",
    }
    

    Suppliers

    The supplier object

    Example Response

    {
      "id": 1000,
      "company": "Own Supplier",
      "name": "John Doe",
      "email": "johndoe@mail.com",
      "phone": "+12 34 56 789",
      "account_number": "EVOX001",
      "enabled": true,
      "locations": [
        {
          "id": 1,
          "name": "Warehouse",
          "enabled": true
        },
        {
          "id": 2,
          "name": "Home",
          "enabled": true
        }
      ],
      "created_at": 1517481635,
      "updated_at": 1528810333
    }
    

    Attributes

    Attribute Description
    id integer The supplier id
    company integer The supplier company name
    name string The supplier name
    email string The supplier email
    phone string The supplier phone number
    account_number string The supplier account number
    enabled boolean True if the supplier is enabled
    locations array An array of available supplier locations
       id     integer The location id
       name     integer The location name
       enabled     integer True if the location is enabled
    created_at timestamp The supplier creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the supplier was last updated (Unix timestamp in UTC)

    Suppliers list

    curl "https://us.evoapi.io/suppliers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 1000,
      "data": [
        {
          "id": 1000,
          "company": "Own Supplier",
          "name": "John Doe",
          "email": "johndoe@mail.com",
          "phone": "+12 34 56 789",
          "account_number": "EVOX001",
          "enabled": true,
          "locations": [
            {
              "id": 1,
              "name": "Warehouse",
              "enabled": true
            },
            {
              "id": 2,
              "name": "Home",
              "enabled": true
            }
          ],
          "created_at": 1517481635,
          "updated_at": 1528810333
        }
      ]
    }
    

    This endpoint retrieves all available suppliers.

    HTTP Request

    GET https://us.evoapi.io/suppliers

    Query Parameters

    Parameter Description Example
    limit The number of suppliers you want. Default is 10 and max is 100. 10
    from_id The supplier id you want to start from. 1111122
    ids A list of ids you want to filter suppliers. 1111122,1111123,1111125
    company Filter supplier by company. Own Supplier
    name Filter supplier by name. John Doe
    email Filter supplier by email. johndoe@mail.com
    account_number Filter by the suppliers account number EVOX001
    enabled True if you want to get only enabled suppliers. true
    created_at The creation date of the supplier. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the supplier. Same as the rule above. 1516693636

    Account Managers

    The Account Manager Object

    Example Response

    {
      "id": 8,
      "name": "John Doe",
      "title" : "Sales Rep",
      "seller_reference": "JD",
      "email": "john@example.com",
      "cell" : "+1 98765432",
      "phone" : "+1 98765432",
      "fax" : "+1 98765432",
      "comments" : "This is an account manager.",
      "image": "image.png",
      "image_path": "https://example.com/xxxxx/",
      "enabled": true,
      "created_at": 1549359776,
      "updated_at": 1549359776
    }
    

    Attributes

    Attribute Description
    id integer The id
    name string The name
    title string The title
    seller_reference string The seller reference
    email string The email
    cell string The cell
    phone string The phone
    fax string The fax
    comments string The comments
    image string The image file name
    image_path string The image file path
    enabled boolean True if enabled
    created_at timestamp The creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC)

    Account Managers List

    curl "https://us.evoapi.io/account-managers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 8,
      "data": [
        {
          "id": 8,
          "name": "John Doe",
          "title" : "Sales Rep",
          "seller_reference": "JD",
          "email": "john@example.com",
          "cell" : "+1 98765432",
          "phone" : "+1 98765432",
          "fax" : "+1 98765432",
          "comments" : "This is an account manager.",
          "image": "image.png",
          "image_path": "https://example.com/xxxxx/",
          "enabled": true,
          "created_at": 1549359776,
          "updated_at": 1549359776
        }
      ]
    }
    

    This endpoint retrieves all available branches, managed and own branches.

    HTTP Request

    GET https://us.evoapi.io/account-managers

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The record id you want to start from. 1111122
    ids A list of ids you want to filter branches. 1111122,1111123,1111125
    seller_reference Filter by seller reference. JD
    name Filter by name. John Doe
    email Filter by email. john@example.com
    enabled True if you want to get only enabled records. true
    created_at The creation date of the branch. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the branch. Same as the rule above. 1516693636

    Branches

    The branch object

    Example Response

    {
      "id": 4,
      "name": "My Main Branch",
      "code": "MAIN",
      "email": "admin@mystore.com",
      "phone": "00000000",
      "address": {
        "title": "My Billing Address",
        "code": "ADDR1",
        "name": "Jonh Doe",
        "company": "EvolutionX",
        "phone": "+1 98765432",
        "line_1": "Building 3",
        "line_2": "12 Street Terrace",
        "line_3": null,
        "city": "Glasgow",
        "state": "Glasgow (City of)",
        "zip": "G1 1RF",
        "country": "GB",
      },
      "enabled": true,
      "created_at": 1517400946,
      "updated_at": 1537734891
    }
    

    Attributes

    Attribute Description
    id integer The branch id
    name string The branch name
    code string The branch code
    email string The branch email
    phone string The branch website
    address object The branch address object
      title   string The address title
      code   string The address code. Used by Evolink to store the Backoffice System ID. Changing this could prevent synchronisation of the records
      name   string The customer name on the order
      company   string The customer company on the order
      phone   string The customer phone on the address
      line_1   string The address line 1
      line_2   string The address line 2
      line_3   string The address line 3
      city   string The address city
      state   string The address state / county The address state / county (required for US)
      zip   string The address zip / postcode, this is a required field for the UK and US only
      country   string Two-letter ISO code representing the address country
    enabled boolean True if the branch is enabled
    created_at timestamp The branch creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the branch was last updated (Unix timestamp in UTC)

    Branches List

    curl "https://us.evoapi.io/branches" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 4,
      "data": [
        {
          "id": 4,
          "name": "My Main Branch",
          "code": "MAIN",
          "email": "admin@mystore.com",
          "phone": "00000000",
          "address": {
            "title": "My Billing Address",
            "code": "ADDR1",
            "name": "Jonh Doe",
            "company": "EvolutionX",
            "phone": "+1 98765432",
            "line_1": "Building 3",
            "line_2": "12 Street Terrace",
            "line_3": null,
            "city": "Glasgow",
            "state": "Glasgow (City of)",
            "zip": "G1 1RF",
            "country": "GB",
          },
          "enabled": true,
          "created_at": 1517400946,
          "updated_at": 1537734891
        }
      ]
    }
    

    This endpoint retrieves all available branches, managed and own branches.

    HTTP Request

    GET https://us.evoapi.io/branches

    Query Parameters

    Parameter Description Example
    limit The number of branches you want. Default is 10 and max is 100. 10
    from_id The branch id you want to start from. 1111122
    ids A list of ids you want to filter branches. 1111122,1111123,1111125
    name Filter branch by name. My Awesome Branch
    code Filter branch by code. MAIN
    enabled True if you want to get only enabled branches. true
    created_at The creation date of the branch. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the branch. Same as the rule above. 1516693636

    Brands

    The brand object

    Example Response

    {
      "id": 9999999,
      "name": "My Awesome Brand",
      "logo": "https://somecdn/brand.jpg",
      "website": "https://somebrandwebsite.com",
      "phone": "+12 34 56 789",
      "managed": false,
      "enabled": true,
      "created_at": 1517481635,
      "updated_at": 1528810333
    }
    

    Attributes

    Attribute Description
    id integer The brand id
    name string The brand name
    logo string The brand email
    website string The brand website
    phone string The brand phone number
    managed boolean True if it's a managed brand
    enabled boolean True if the brand is enabled
    created_at timestamp The brand creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the brand was last updated (Unix timestamp in UTC)

    Brands list

    curl "https://us.evoapi.io/brands" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 999999,
      "data": [
        {
          "id": 9999999,
          "name": "My Awesome Brand",
          "logo": "https://somecdn/brand.jpg",
          "website": "https://somebrandwebsite.com",
          "phone": "+12 34 56 789",
          "managed": false,
          "enabled": true,
          "created_at": 1517481635,
          "updated_at": 1528810333
        }
      ]
    }
    

    This endpoint retrieves all available brands, managed and own brands.

    HTTP Request

    GET https://us.evoapi.io/brands

    Query Parameters

    Parameter Description Example
    limit The number of brands you want. Default is 10 and max is 100. 10
    from_id The brand id you want to start from. 1111122
    ids A list of ids you want to filter brands. 1111122,1111123,1111125
    name Filter brand by name. My Awesome Brand
    managed Filter managed or own brands. false
    enabled True if you want to get only enabled brands. true
    created_at The creation date of the brand. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the brand. Same as the rule above. 1516693636

    Categories

    The Category Object

    Example Response

    {
      "id": 1000000,
      "parent_id": 0,
      "classification_id": 1,
      "supplier_id": 1000,
      "layout_id": null,
      "name": "My Category",
      "content": null,
      "image": null,
      "image_path": null,
      "sort_order": 100,
      "meta_title": null,
      "meta_keyword": null,
      "meta_description": null,
      "from": 1420070400,
      "to": 1893456000,
      "enabled": true,
      "created_at": 1517407228,
      "updated_at": 1517407228,
      "url": "my-category"
    
    }
    

    Attributes

    Attribute Description
    id integer The category id
    parent_id integer The parent category id
    classification_id integer The category vertical id.
    supplier_id integer The supplier id. For own categories, this will be 1000.
    layout_id integer The layout id
    name string The name. For managed categories, it will return the Managed Name unless the Name has changed.
    content string The content
    image string The image
    image_path string The image path
    sort_order integer The sort order
    meta_title string The meta title
    meta_keyword string The meta keyword
    meta_description string The meta description
    enabled boolean Is the record enabled
    from timestamp The starting date (Unix timestamp in UTC).
    to timestamp The ending date (Unix timestamp in UTC).
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when last updated (Unix timestamp in UTC).
    url_key string The url slug. Included on request.

    List All Categories

    curl "https://us.evoapi.io/categories" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "id": 1000000,
      "parent_id": 0,
      "classification_id": 1,
      "supplier_id": 1000,
      "layout_id": null,
      "name": "My Category",
      "content": null,
      "image": null,
      "image_path": null,
      "sort_order": 100,
      "meta_title": null,
      "meta_keyword": null,
      "meta_description": null,
      "from": 1420070400,
      "to": 1893456000,
      "enabled": true,
      "created_at": 1517407228,
      "updated_at": 1517407228
    }
    

    This endpoint retrieves all categories.

    HTTP Request

    GET https://us.evoapi.io/categories

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    include_url True if you want to inlcude the categories url keys into the response, which results in a slower response. false
    from_id The customer id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    name Filter by name My Category
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Catalogs

    The Catalog Object

    Example Response

    {
      "id": 1000,
      "name": "Own Catalog",
      "from": 1517356800,
      "to": 1580428800,
      "autoupdate": true,
      "autodiscontinue": true,
      "enabled": true,
      "created_at": 1525447406,
      "updated_at": 1525447406
    }
    

    Attributes

    Attribute Description
    id integer The category id
    name string The catalog name
    from timestamp The starting date (Unix timestamp in UTC).
    to timestamp The ending date (Unix timestamp in UTC).
    autoupdate boolean Is the catalog auto update
    autodiscontinue boolean Is the catalog auto discontinue
    enabled boolean Is the record enabled
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when last updated (Unix timestamp in UTC).

    List All Catalogs

    curl "https://us.evoapi.io/catalogs" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "id": 1000,
      "name": "Own Catalog",
      "from": 1517356800,
      "to": 1580428800,
      "autoupdate": true,
      "autodiscontinue": true,
      "enabled": true,
      "created_at": 1525447406,
      "updated_at": 1525447406
    }
    

    This endpoint retrieves all catalogs.

    HTTP Request

    GET https://us.evoapi.io/catalogs

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    The Catalog Container Object

    Example Response

    {
      "id": 1,
      "type_id": 1,
      "rule_type_id": 1,
      "name": "My Catalog Container",
      "catalogs": 0,
      "customers": 0,
      "combos": 0,
      "items": 0,
      "exclude_empty_categories": true,
      "from": 1514764800,
      "to": 1546214400,
      "enabled": true,
      "created_at": 1517402295,
      "updated_at": 1535972827
    }
    

    Attributes

    Attribute Description
    id integer The id
    type_id integer The type id
    rule_type_id integer The rule type id
    name string The name
    catalogs integer The number of catalogs rules
    customers integer The number of associated customers (only when container type is for accounts)
    customers integer The number of customers rules
    combos integer The number of combo rules
    items integer The number of container items
    exclude_empty_categories boolean Exclude empty categories
    from timestamp The date active from (Unix timestamp in UTC)
    to timestamp The date no longer active (Unix timestamp in UTC)
    enabled boolean Is this record active or not
    created_at timestamp The record creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC)

    Catalog Container Type ID's

    ID Description
    1 Global
    2 Accounts
    3 All Accounts

    Catalog Container Rule Type ID's

    ID Description
    1 Exclusion Rules
    2 Inclusion Rules

    List Catalog Containers

    curl "https://us.evoapi.io/catalogs/containers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1,
        "data": [
            {
              "id": 1,
              "type_id": 1,
              "rule_type_id": 1,
              "name": "My Catalog Container",
              "catalogs": 0,
              "customers": 0,
              "combos": 0,
              "items": 0,
              "exclude_empty_categories": true,
              "from": 1514764800,
              "to": 1546214400,
              "enabled": true,
              "created_at": 1517402295,
              "updated_at": 1535972827
            }
        ]
    }
    

    This endpoint retrieves a list of catalog containers.

    HTTP Request

    GET https://us.evoapi.io/catalogs/containers

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter by. 1111122,1111123,1111125
    name Filter by the name My Container
    type_id Filter by type_id. 1
    enabled True if you want to get only enabled customers. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Create Catalog Container

    This request will allow you to create a new catalog container

    Example POST Request

    curl "https://us.evoapi.io/catalogs/containers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "name": "My Container", "from": 1514764800, "to": 1514764800, "exclude_empty_categories": false, "type_id": 2, "rule_type_id": 1, "customers": [1000000, 1000001], "catalogs": [ { "catalog_id": 1000, "search_priority": 1, "priority": 1, } ] }'
    

    JSON

    {
      "name": "My Container",
      "from": 1514764800,
      "to": 1614764800,
      "type_id": 2,
      "rule_type_id": 1,
      "exclude_empty_categories": false,
      "customers": [1000000, 1000001],
      "catalogs": [
        {
          "catalog_id": 1000,
          "search_priority": 1,
          "priority": 1
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/catalogs/containers

    Attributes

    Attribute Description
    name string required The name
    from timestamp required The date when the container starts (Unix timestamp in UTC)
    to timestamp required The date when the container ends (Unix timestamp in UTC)
    type_id integer required The container type id (1: Global, 2: Accounts)
    rule_type_id integer required The container rule type (1: Exclusion, 2: Inclusion)
    exclude_empty_categories boolean Exclude empty categories
    customers array An array of customer id's
    catalogs array An array of catalog objects
      catalog_id   integer   required The catalog id
      search_priority   integer The search priority
      priority   integer The priority
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "container": {
        "id": 48,
        "type_id": 2,
        "rule_type_id": 1,
        "name": "My Container",
        "customers": 1,
        "combos": 0,
        "items": 0,
        "exclude_empty_categories": false,
        "from": 1514764800,
        "to": 1614729600,
        "enabled": true,
        "created_at": 1536175104,
        "updated_at": 1536175104
      }
    }
    

    Update Catalog Container

    You would use this request to update a catalog container

    Example PUT Request

    curl "https://us.evoapi.io/catalogs/containers/container_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X PUT - d '{ "name": "My Container Name Update" }'
    

    JSON

    {
      "name": "My Container Name Update"
    }
    

    HTTP Request

    PUT https://us.evoapi.io/catalogs/containers/container_id

    Attributes

    Attribute Description
    name string The name
    from timestamp The date when the container starts (Unix timestamp in UTC)
    to timestamp The date when the container ends (Unix timestamp in UTC)
    type_id integer The container type id (1: Global, 2: Accounts)
    rule_type_id integer The container rule type (1: Exclusion, 2: Inclusion) NOTE: Changing this field will result in the deletion any Inclusion / Exclusion rules associated to this container.
    exclude_empty_categories boolean Exclude empty categories
    customers array An array of customer id's. This will replace the existing customers. Empty array will not be taken into account. For single use the Add Container Customer endpoint
    catalogs array An array of catalog objects
      catalog_id   integer   required The catalog id
      search_priority   integer The search priority
      priority   integer The priority
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "container": {
        "id": 48,
        "type_id": 2,
        "rule_type_id": 1,
        "name": "My Container",
        "customers": 1,
        "combos": 0,
        "items": 0,
        "exclude_empty_categories": false,
        "from": 1514764800,
        "to": 1614729600,
        "enabled": true,
        "created_at": 1536175104,
        "updated_at": 1536175104
      }
    }
    

    Delete Catalog Container

    Delete a catalog container

    Example DELETE Request

    curl "https://us.evoapi.io/catalogs/containers/container_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/catalogs/containers/container_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The Container Combo Object

    Example Response

    {
      "id": 350,
      "type_id": 2,
      "catalog_id": 1000,
      "catalog": "Own Catalog",
      "supplier_id": null,
      "supplier": null,
      "brand_id": 4516,
      "brand": "Brand",
      "category_id": null,
      "category": null,
      "manufacturer_id": 1024,
      "manufacturer": "Manufacturer",
      "matrix": "0",
      "enabled": true,
      "created_at": 1536169948,
      "updated_at": 1536169948
    }
    

    Attributes

    Attribute Description
    id integer The id
    type_id integer The type id
    catalog_id integer The catalog id
    catalog string The catalog name
    supplier_id integer Supplier id
    supplier string The supplier name
    brand_id integer Brand id
    brand string The brand name
    category_id integer Category id
    category string The category name
    manufacturer_id integer Manufacturer id
    manufacturer string The manufacturer name
    matrix string The matrix
    enabled boolean Is the combo rule enabled
    created_at timestamp The record creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC)

    List of Container Combo Rules

    curl "https://us.evoapi.io/catalogs/containers/container_id/combos" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 350,
        "data": [
            {
              "id": 350,
              "type_id": 2,
              "catalog_id": 1000,
              "catalog": "Own Catalog",
              "supplier_id": null,
              "supplier": null,
              "brand_id": 4516,
              "brand": "Sparkle",
              "category_id": null,
              "category": null,
              "manufacturer_id": 1024,
              "manufacturer": "Manufacturer",
              "matrix": "0",
              "enabled": true,
              "created_at": 1536169948,
              "updated_at": 1536169948
            }
        ]
    }
    

    This endpoint retrieves a list of container combo rules

    HTTP Request

    GET https://us.evoapi.io/catalogs/containers/container_id/combos

    Query Parameters

    Parameter Description Example
    limit The number of address you want. Default is 10 and max is 100. 10
    from_id The address id you want to start from. 1111122
    ids A list of ids you want to filter addresses. 1111122,1111123,1111125
    catalog_id Filter by catalog id. 1000
    category_id Filter by category id. 1000000
    brand_id Filter by brand id. 1000
    manufacturer_id Filter by manufacturer id. 1000
    supplier_id Filter by supplier id. 1000
    matrix Filter by catalog id. H
    enabled True if you want to get only enabled customers. true
    created_at The creation date of the addresses. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the addresses. Same as the rule above. 1516693636

    Add Combo Rule to Catalog Container

    This request will allow you to add combo rules to a catalog container

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/catalogs/containers/container_id/combos" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [ { "catalog_id": 1000, "category_id": 1000000, "brand_id": 1000, "manufacturer_id": 1000, "supplier_id": 1000, "matrix": "H", } ] }'
    

    JSON

    {
      "data": [
        {
          "catalog_id": 1000,
          "category_id": 1000000,
          "brand_id": 1000,
          "manufacturer_id": 1000,
          "supplier_id": 1000,
          "matrix": "H"
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/catalogs/containers/container_id/combos

    Attributes

    Attribute Description
    data array required An array of product objects
      catalog_id   integer The catalog id
      category_id   integer The category id
      brand_id   integer The brand id
      manufacturer_id   integer The manufacturer id
      supplier_id   integer The supplier id
      matrix   string The matrix band
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
            "item_id": 9000000,
            "catalog_id": 1000
          },
          "reason": "Product does not exist"
        }
      ]
    }
    

    Delete Container Combo Rule

    Delete a container combo rule

    Example DELETE Request

    curl "https://us.evoapi.io/catalogs/containers/container_id/combos/combo_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/catalogs/containers/container_id/combos/combo_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The Catalog Container Items Object

    Example Response

    {
      "item_id": 1451375,
      "catalog_id": 1000,
      "supplier_id": 1002,
      "title": "My Product",
      "sku": "MYPROD001",
      "description": "My product description",
      "created_at": 1536168960,
      "updated_at": 1536168960
    }
    

    Attributes

    Attribute Description
    id integer The products id
    catalog_id integer The catalog id
    supplier_id integer Supplier id
    title string The products title
    sku string The products sku
    description integer The product description
    created_at timestamp The record creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC)

    List of Container Items

    curl "https://us.evoapi.io/catalogs/containers/container_id/items" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1451375,
        "data": [
            {
              "item_id": 1451375,
              "catalog_id": 1000,
              "supplier_id": 1002,
              "title": "My Product",
              "sku": "MYPROD001",
              "description": "My product description",
              "created_at": 1536168960,
              "updated_at": 1536168960
            }
        ]
    }
    

    This endpoint retrieves a list of container items

    HTTP Request

    GET https://us.evoapi.io/catalogs/containers/container_id/items

    Query Parameters

    Parameter Description Example
    limit The number of records you want. Default is 10 and max is 100. 10
    from_id The address id you want to start from. 1111122
    ids A list of ids you want to filter by. 1111122,1111123,1111125
    name Filter by the name My Container
    sku Filter by the sku MYPROD001
    enabled True if you want to get only enabled records. true
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Add Item to Catalog Container

    This request will allow you to add items to a catalog container

    This is a bulk request meaning that you can add up to 10 records at a time using the data array.

    Example POST Request

    curl "https://us.evoapi.io/catalogs/containers/container_id/items" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"\
      -X POST -d '{ "data": [{ "item_id": 1000000, "catalog_id": 1000 }] }'
    

    JSON

    {
      "data": [
        {
          "item_id": 1000000,
          "catalog_id": 1000
        }
      ]
    }
    
    

    HTTP Request

    POST https://us.evoapi.io/catalogs/containers/container_id/items

    Attributes

    Attribute Description
    data array required An array of product objects
      item_id   integer required The product item id
      catalog_id   integer required The product catalog id
    
    

    There are 3 different responses you can get back:

    Example JSON Response when status is warning/error

    {
      "status": "warning/error",
      "failed": [
        {
          "data": {
            "item_id": 9000000,
            "catalog_id": 1000
          },
          "reason": "Product does not exist"
        }
      ]
    }
    

    Delete Container Items

    Delete a container item

    Example DELETE Request

    curl "https://us.evoapi.io/catalogs/containers/container_id/items/item_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/catalogs/containers/container_id/items/item_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The Container Catalog Object

    Example Response

    {
      "catalog_id": 1016,
      "catalog": "OpenRange Spicers UK Basic Oct17",
      "search_priority": 0,
      "priority": 0,
      "created_at": 1518109968,
      "updated_at": 1536568061
    }
    

    Attributes

    Attribute Description
    catalog_id integer The catalog id
    catalog string The catalog name
    search_priority integer The search priority
    priority integer The priority
    created_at timestamp The record creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC)

    List of Container Catalogs

    curl "https://us.evoapi.io/catalogs/containers/container_id/catalogs" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1016,
        "data": [
            {
                "catalog_id": 1016,
                "catalog": "OpenRange Spicers UK Basic Oct17",
                "search_priority": 0,
                "priority": 0,
                "created_at": 1518109968,
                "updated_at": 1536568061
            }
        ]
    }
    

    This endpoint retrieves a list of container catalogs

    HTTP Request

    GET https://us.evoapi.io/catalogs/containers/container_id/catalogs

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter by. 1111122,1111123,1111125
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Delete Container Catalog

    Delete a container catalog

    Example DELETE Request

    curl "https://us.evoapi.io/catalogs/containers/container_id/catalogs/catalog_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/catalogs/containers/container_id/catalogs/catalog_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    The Container Customer Object

    Example Response

    {
      "customer_id": 1003861,
      "name": "Customer",
      "account_number": "19191",
      "company": "Company",
      "created_at": 1537368162,
      "updated_at": 1537368162
    }
    

    Attributes

    Attribute Description
    customer_id integer The customer id
    name string The customer name
    account_number string The customer account number
    company string The customer company
    created_at timestamp The record creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the record was last updated (Unix timestamp in UTC)

    List of Container Customers

    curl "https://us.evoapi.io/catalogs/containers/container_id/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "has_more": false,
        "last_id": 1003861,
        "data": [
            {
              "customer_id": 1003861,
              "name": "Customer",
              "account_number": "19191",
              "company": "Company",
              "created_at": 1537368162,
              "updated_at": 1537368162
            }
        ]
    }
    

    This endpoint retrieves a list of container customers

    HTTP Request

    GET https://us.evoapi.io/catalogs/containers/container_id/customers

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The id you want to start from. 1111122
    ids A list of ids you want to filter by. 1111122,1111123,1111125
    created_at The creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update. Same as the rule above. 1516693636

    Add Container Customer

    curl "https://us.evoapi.io/catalogs/containers/container_id/customers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
      -X POST '{ "customer_id": 1003861 } '
    
    
    

    The above command returns JSON structured like this:

    {
        "status": "success",
        "container_account": {
            "customer_id": 1003861,
            "name": "Customer",
            "account_number": "19191",
            "company": "Company",
            "created_at": 1537368162,
            "updated_at": 1537368162
        }
    }
    

    This request will allow you to add a customer to a catalog container

    HTTP Request

    POST https://us.evoapi.io/catalogs/containers/container_id/customers

    Query Parameters

    Parameter Description Example
    customer_id integerrequired The customer id 1003861

    Delete Container Customer

    Delete a container customer

    Example DELETE Request

    curl "https://us.evoapi.io/catalogs/containers/container_id/customers/customer_id" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json" \
      -X DELETE
    

    HTTP Request

    DELETE https://us.evoapi.io/catalogs/containers/container_id/customers/customer_id

    
    

    The above command returns JSON structured like this:

    {
        "status": "success"
    }
    

    Labels

    The Label Object

    Example Response

    {
      "id": 1,
      "name": "My Label",
      "hex": "0052CC",
      "type_id": 2,
      "type": "product",
      "enabled": true,
      "created_at": 1517560291,
      "updated_at": 1517560291
    }
    

    Attributes

    Attribute Description
    id integer The label id
    name integer The label name
    hex string The label hex color
    type_id integer The label type id
    type string The label type
    enabled boolean Is the record enabled
    created_at timestamp The creation date (Unix timestamp in UTC).
    updated_at timestamp The date when last updated (Unix timestamp in UTC).

    Label Type ID's

    ID Description
    1 Customer
    2 Product
    5 Tax

    List All Labels

    curl "https://us.evoapi.io/labels" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "id": 1,
      "name": "My Label",
      "hex": "0052CC",
      "type_id": 2,
      "type": "product",
      "enabled": true,
      "created_at": 1517560291,
      "updated_at": 1517560291
    }
    

    This endpoint retrieves all categories.

    HTTP Request

    GET https://us.evoapi.io/labels

    Query Parameters

    Parameter Description Example
    limit The number of items you want. Default is 10 and max is 100. 10
    from_id The label id you want to start from. 1
    ids A list of ids you want to filter by. 1,2,3
    name Filter by name My Label
    type_id Filter by type id 1
    enabled True if you want to get only enabled items. true
    created_at Filter by creation date. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at Filter by the updated date. Same as the rule above. 1516693636

    Manufacturers

    The manufacturer object

    Example Response

    {
      "id": 9999999,
      "name": "My Awesome Manufacturer",
      "logo": "https://somecdn/manufacturer.jpg",
      "website": "https://somemanufacturerwebsite.com",
      "phone": "+12 34 56 789",
      "managed": false,
      "enabled": true,
      "created_at": 1517481635,
      "updated_at": 1528810333
    }
    

    Attributes

    Attribute Description
    id integer The manufacturer id
    name string The manufacturer name
    logo string The manufacturer email
    website string The manufacturer website
    phone string The manufacturer phone number
    managed boolean True if it's a managed manufacturer
    enabled boolean True if the manufacturer is enabled
    created_at timestamp The manufacturer creation date (Unix timestamp in UTC)
    updated_at timestamp The date when the manufacturer was last updated (Unix timestamp in UTC)

    Manufacturers list

    curl "https://us.evoapi.io/manufacturers" \
      -H "Authorization: Bearer your_secret_key" \
      -H "Accept: application/vnd.evolutionx.v1+json"
    
    
    

    The above command returns JSON structured like this:

    {
      "status": "success",
      "has_more": false,
      "last_id": 999999,
      "data": [
        {
          "id": 9999999,
          "name": "My Awesome Manufacturer",
          "logo": "https://somecdn/manufacturer.jpg",
          "website": "https://somemanufacturerwebsite.com",
          "phone": "+12 34 56 789",
          "managed": false,
          "enabled": true,
          "created_at": 1517481635,
          "updated_at": 1528810333
        }
      ]
    }
    

    This endpoint retrieves all available manufacturers, managed and own manufacturers.

    HTTP Request

    GET https://us.evoapi.io/manufacturers

    Query Parameters

    Parameter Description Example
    limit The number of manufacturers you want. Default is 10 and max is 100. 10
    from_id The manufacturer id you want to start from. 1111122
    ids A list of ids you want to filter manufacturers. 1111122,1111123,1111125
    name Filter manufacturer by name. My Awesome Manufacturer
    managed Filter managed or own manufacturers. false
    enabled True if you want to get only enabled manufacturers. true
    created_at The creation date of the manufacturer. It could either be a Unix timestamp in UTC or a dictionary for date ranges. 1516693636
    updated_at The last update of the manufacturer. Same as the rule above. 1516693636

    Orders

    The Order Obje