Introduction

The Merchanter API is a RESTful service to facilitate integration between Merchanter and other client systems.

Summary of Changes (since v1.0)

• GET operations for accounts
  • Added object ID
• GET operations for customer accounts
  • Added object ID
  • Added payment terms description and settlement discount percentage
  • Added county and fax number to addresses
  • Added country code to addresses (removing country container)
  • Added ID and name to delivery addresses
  • Added line 3 to addresses
• GET operations for depots
  • Added object ID
  • Added depot type
  • Added county and fax number to default address
  • Added country code to default address (removing country container)
  • Added line 3 to the default address
• GET operations for products
  • Added object ID
  • Added species name
  • Added descriptive product tags (for uses)
  • Added weight factor, weight factor unit of measure (kgs or tonnes) and weight factor per unit of measure
  • Added base price
  • Added VAT rate percentage
  • Added prices (for each customer price band)
  • Added last changed date & time
  • Added ecommerce description (short description)
  • Added product category name & shortname
  • Added ecommerce attributes string
  • Changed attributes ProductGroupName & ProductGroupShortName to Name & ShortName
  • Changed attributes ProductSubGroupName & ProductSubGroupShortName to Name & ShortName
  • Added product stock controlled flag
• GET operation for product prices
  • Changed attribute ProductCode to Code
• New single object GET operations for
  • Customer accounts
  • Products
  • Sales orders
• New POST operation for customer accounts
• POST operation for customer account payments
  • Request
    • Upped max length of payment reference from 20 to 200
  • Response
    • Changed attribute _ID to ID
• POST operation for sales orders
  • Request
    • Added AdditionalComments (notes) for items
    • Upped max length of WebOrderRef from 12 to 30
    • Specification string attribute extended to support mixed width/size specifications
    • Added Street3 for 3^rd line of shipping address
    • Added CustomerReference
  • Response
    • Added OrderStatus, AdditionalComments & OrderNumberWithSuffix
    • Removed InternalOrderNumber
    • Changed attribute _ID to ID
    • Changed delivery address attributes Address1, Address2, Address3, Postcode & PhoneNr to AddressLine1, AddressLine2, AddressLine3, PostalCode & PhoneNumber
    • Upped max length of CustomerReference from 60 to 200

Authentication

At the time of writing this document, the Merchanter API service uses basic authentication. This allows the clients to authenticate themselves by providing a username and password in the Authorization HTTP header.

Resources

The service exposes a number of resources. A resource represents a collection of items on which one or more operations can be defined. The resources available are as follows: -

• Accounts – user accounts Merchanter API v1.1 - User Accounts 
• CustomerAccounts – customer accounts Merchanter API v1.1 - Customer Accounts 
  • CustomerAccountPayments – customer account payments
  • CustomerAccountPrices – customer account prices 
  • CustomerAccountTransactions – customer account transactions
• Depots – branches, quays, and warehouse stores Merchanter API v1.1 - Depots 
• Products – products Merchanter API v1.1 - Products 
• ProductPrices – product prices Merchanter API v1.1 - Product Prices 
• Sales – sales orders Merchanter API v1.1 - Sales 
• Stock – depot stock summaries Merchanter API v1.1 - Stock 

Operations

Content Types

GET operations can send data in either XML (the default) or JSON format. If JSON is required, the request must be sent with an Accept HTTP header and the value “application/json”.

POST/PUT operations can receive data in either XML (the default) or JSON format. If JSON is required, the request must be sent with a Content-Type HTTP header and the value “application/json”.

Endpoints

The URL of every endpoint always starts with a base url:-

{Merchanter application url}/rest/api.merch/v1.1

Only the relative URL is shown for each endpoint.