Farfetch API Manual

FARFETCH
API Technical Manual
January 2015
Dept.: Back Office

Description: Farfetch API Technical Manual

Dept.: Tech Back Office 1
Date: January 08, 2015
Version: 2.0
Intent
This document is intended for technical audiences and reflects all methods available on
Farfetch back office API to be used on systems integration with Farfetch systems.
It covers areas such as Stock Sync and Order Workflow, you can integrate each of this
areas separately according to your needs, please discuss with your Farfetch buddy what is
the level of integration you should implement with Farfetch.
Scope
This document is intended for use by technical representatives of our partners when
synchronizing with Farfetch API.
Definitions
Key - Parameter used in our API to authenticate and define the store the request is being
made for. Please request Farfecth for a valid key for your company, we also provide a test
key to be used on our sandbox environment for testing purposes.
Technical considerations
This document is written considering that the reader is well known in .net techonogies wich
is the main API technology used by Farftech web services.
Endpoints and sandbox

Please refer to these endpoints to work with our environments
Live
Endpoint url: http://sales-ws.farfetch.com/pub/apistock.asmx
Sandbox
Endpoint url: http://rcs01-sales.fftech.info/pub/apistock.asmx
Test store:
Store name: BOB
StoreId: 9441;
Key: nExd8CzMRDo=

Version: 2.0
Table of Contents
FARFETCH ......................................................................................................................................1
API Technical Manual ...............................................................................................................1
Intent ..............................................................................................................................................2
Scope .............................................................................................................................................2
Definitions.....................................................................................................................................2
Technical considerations .........................................................................................................2
Endpoints and sandbox ............................................................................................................2
Functions ............................................................................................................................................6
 BarcodeProcess ....................................................................................................................6
 BarcodeProcessAbsoluteQuantity......................................................................................7
 GetAllItems.............................................................................................................................8
 GetAllItemsWithStock ...........................................................................................................9
 GetAllOrders ........................................................................................................................10
 GetCustomer........................................................................................................................11
 GetFFItem ............................................................................................................................13
 GetInvoice ............................................................................................................................14
 GetItemTotalStock ..............................................................................................................16
 GetOrdersByDate................................................................................................................17
 GetOrdersHeaders..............................................................................................................18
 GetOrdersRows ...................................................................................................................19
 GetPackages .......................................................................................................................20
 GetReturns ...........................................................................................................................20
 GetStockByBarcode ...........................................................................................................21
 GetStockBySize ..................................................................................................................22
 ItemIDProcess .....................................................................................................................23
 ItemIDProcessAbsoluteQuantity .......................................................................................25
 OrderStatusUpdate .............................................................................................................26
 SendOrderStep1toStep2....................................................................................................27
 SendOrderStep3toStep4WithPackages ..........................................................................29
 StockCompare .....................................................................................................................29
 ValidateReturn .....................................................................................................................30

Version: 2.0
Version: 2.0
Table of Contents
FARFETCH ......................................................................................................................................1
API Technical Manual ...............................................................................................................1
Intent ..............................................................................................................................................2
Scope .............................................................................................................................................2
Definitions.....................................................................................................................................2
Technical considerations .........................................................................................................2
Endpoints and sandbox ............................................................................................................2
Functions ............................................................................................................................................6
 BarcodeProcess ....................................................................................................................6
 BarcodeProcessAbsoluteQuantity......................................................................................7
 GetAllItems.............................................................................................................................8
 GetAllItemsWithStock ...........................................................................................................9
 GetAllOrders ........................................................................................................................10
 GetCustomer........................................................................................................................11
 GetFFItem ............................................................................................................................13
 GetInvoice ............................................................................................................................14
 GetItemTotalStock ..............................................................................................................16
 GetOrdersByDate................................................................................................................17
 GetOrdersHeaders..............................................................................................................18
 GetOrdersRows ...................................................................................................................19
 GetPackages .......................................................................................................................20
 GetReturns ...........................................................................................................................20
 GetStockByBarcode ...........................................................................................................21
 GetStockBySize ..................................................................................................................22
 ItemIDProcess .....................................................................................................................23
 ItemIDProcessAbsoluteQuantity .......................................................................................25
 OrderStatusUpdate .............................................................................................................26
 SendOrderStep3toStep4WithPackages ..........................................................................29
 StockCompare .....................................................................................................................29
 ValidateReturn .....................................................................................................................30

Version: 2.0
Functions
 BarcodeProcess
This will add or remove (stock in, stock out) an amount of stock from a given barcode.
If the amount is negative, it will remove that amount from the stock; if positive it will add.
Accepts Farfetch barcodes and store barcodes if defined previously. You can define Store
Barcodes when creating the product, or if the product was already created with a Store
Barcode please inform your AM/PS contact to help further.
Parameter Type Description

Key String A key provided by us so you can access this
information.
Barcode String Our Barcode or Store Barcode for the article.
Qty Integer The amount of stock to add. (Negative value if
you want to remove.
ErrMsg String
IsAdjustment Boolean Classification of the movement. True if is a
adjustment movement, false if is a normal stock
movement (ex: insert or remove stock).
CurrentStock Integer Total stock of the product.
Output Type Description Notes

ErrMsg String A message containing the error, if
it occurs.
BarcodeProcessResult Boolean True if it was a successful call.
False if it wasn’t.

Version: 2.0
 BarcodeProcessAbsoluteQuantity
Will set the current stock of a given barcode. Accepts Farfetch barcodes and store
barcodes if defined previously.
Accepts Farfetch barcodes and store barcodes if defined previously. You can define Store
Barcodes when creating the product, or if the product was already created with a Store
Barcode please inform your AM/PS contact to help further.

information.
Barcode String Our Barcode or Store Barcode for the article.
AbsoluteQty Integer The amount of absolute stock to set (Negative
value is not allowed).
ErrMsg String
movement.

ErrMsg String A message containing the
error, if it occurs.
BarcodeProcessAbsoluteQuantity Boolean True if it was a successful
Result call. False if it wasn’t.

Version: 2.0
 GetAllItems
Will return all Items with their stock information and the fields described below.

information.

it occurs.
GetAllItemsResult Datatable Containing the following fields:
 ItemID (Our article id);
 Brand (The Brand of the
article);
 Department (The top level
Category of the article);
 Group (The lowest level
 Name (The reference of the
article);
 FullPrice (The base price of
the article);
 DiscountPrice (The price of
the article with discount);
 Size (The size of the article);
 Quantity (The stock quantity
for that size of the article);
 SizeRangeType (The name of
the size range used by the
article);
 Style (The Designer Id);
GenderID (Our Gender Id);
 Gender

Version: 2.0
 GetAllItemsWithStock
Will return all Items that currently have stock in Farfetch, the fields described below.

information.

it occurs.
GetAllItemsWithStockResult Datatable Containing the following fields:
 ItemID (Our article id);
 Brand (The Brand of the
article);
 Department (The top level
 Group (The lowest level
 Name (The reference of the
article);
 FullPrice (The base price of
the article);
 DiscountPrice (The price of
the article with discount);
 Size (The size of the article);
 Quantity (The stock quantity
for that size of the article);
 SizeRangeType (The name of
the size range used by the
article);
 Style (The Designer Id);
GenderID (Our Gender Id);
 Gender
 SeasonID (Season
identifier);
 Season (Season name);
 Barcode (Barcode
associated with Item)
 SKU (Item SKU)

Version: 2.0
 GetAllOrders
Will return all orders that are waiting for stock validation.

information.

ErrMsg String A message containing the error, if it
occurs.
GetAllOrdersResult Datatable Containing the following fields:
 OrderID (The id of the order);
 Qtd (The quantity of the
article ordered);
 Ref (The reference of the
article ordered);
 Size (The size of the article
ordered);
 Price (The price paid for the
article ordered);
 ItemID (The id of the article
ordered);
 ShippingType (The shipping
method selected by the
customer);
 CustomerID (The id of the
customer);
 OrderLineID (The id of the
order line);
 ShippingAddress (The
shipping address of the
customer);
 StatusId (The id of the order
status);
 Status (The order status
description).

Version: 2.0
 GetOrders
Will return orders by year and month number that are waiting for stock validation.

information.
Month Integer The month number of the year
Year Integer The year number

occurs.
GetOrdersResult Datatable Containing the following fields:
 OrderID (The id of the order);
article ordered);
article ordered);
 Size (The size of the article
ordered);
 Price (The price paid for the
article ordered);
 ItemID (The id of the article
ordered);
 ShippingType (The shipping
method selected by the
customer);
customer);
 OrderLineID (The id of the
order line);
 IsFromPortal (boolean
indicating if the order came
from portal);
 StoreBarCode (The store
barcode);
 FfBarcode (The farfetch
barcode).

Version: 2.0
 GetCustomer
Will return the details of a given customer id.

information.
CustomerID String The id of the customer.

occurs.
GetAllOrdersResult Datatable Containing the following fields:
 NickName (The name of the
customer);
 Email (Not returning the
actual e-mail address at the
moment. Returning
aaa@aaa.com instead);
 Phone (The phone number
of the customer);
 Address1 (The address line 1
of the customer);
 Address2 (The address line 2
of the customer);
 City (The city of the
customer);
 State (The state of the
customer);
 Zip (The zip/postal code of
the customer);
 Country (The country of the
customer).

Version: 2.0
 GetFFItem
Will return the item id given the following parameters:

SafeKey String A key provided by us so you can access this
information.
storeid String The id of the store.
DesignerId String The id of the designer associated with the item.
SKU String The SKU associated with the article.

GetFFItemResult string The item identifier on Farfetch systems

Version: 2.0
 GetInvoice
Get all invoices between two dates in an xml format.
Date Interval Validation: The interval between the start date and end date cannot exceed
31 days
Other Information: The client application from the partner site will call the API/URL on a
regular basis (example: every “n” minutes) typically it will request the invoices from the
current day. The application on Farfetch side will deliver the information in XML format and
the reply to the GET request. (The XML definition will be proposed latter)
IMPORTANT Farfetch will always deliver all invoices that have been created on the date
interval requested. This means that the client application on the partner will have the
responsibility to identify the invoices that it has already received (repeated) and ignore
them.
Example:
First Request: FF returns invoices A132 and A145 latter on 3 more invoices are created
(A576, A689, and A888)
Next request: FF returns invoices A132, A145, A576, A689, A888

It’s always an incremental list. This way we make sure that no Invoice is lost.

information.
From DateTime Start date of range.
To DateTime End date of range.

GetInvoiceResult String XML Specification:
<XmlOrdersResponseModel
xmlns:xsi=http://www.w3.org/2001/XMLSchemainstance
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<HasError></HasError> <Message></Message>
<Results> <XmlOrdersHeaderModel>
<OrderID></OrderID> <Date></Date>
<InvoiceNumber></InvoiceNumber>
<InvoiceValue></InvoiceValue>
<Currency></Currency> <AWB></AWB> <InvoiceTo>
<Name></Name> <Address></Address> <City></City>
<Zip></Zip> <State></State> <Country></Country>
<Extra_EU></Extra_EU> </InvoiceTo>
<ItemsTotal>473,29</ItemsTotal>
<Shipping>30,27</Shipping>
<GrandTotal>503,55</GrandTotal>
<Vat>0</Vat>
<TotalDDP>146,19</TotalDDP>
<ProductList> <XmlOrdersRowModel>
<Product_ID></Product_ID>
<Product_Description></Product_Description>
<Product_Quantity></Product_Quantity>
<Product_Price></Product_Price> <SKU></SKU>
Version: 2.0
</XmlOrdersRowModel> </ProductList>
</XmlOrdersHeaderModel>
</XmlOrdersResponseModel >

Version: 2.0
 GetItemTotalStock
Will return all stock for all sizes for a given article id.

information.
ItemID String The article id.
ErrMsg String A message that will return the error, if it occurs.

occurs.
GetItemTotalStockResult Datatable Containing the following collumns:
 Size (Size name)
 Stock (stock available for
that size)

Version: 2.0
 GetOrdersByDate
Will return all orders between a given period of time.

information.
StartDate Datetime The date of when the search period starts.
EndDate Datetime The date of when the search period ends.

occurs.
GetOrdersByDateResult Datatable Containing the following fields
 OrderID (The id of the
order);
article ordered);
article ordered);
 Size (The size of the
article ordered);
 Price (The price paid for
the article ordered);
 ItemID (The id of the
article ordered);
 ShippingType (The
shipping method selected
by the customer);
customer);
 OrderLineID (The id of
the order line);
 ShippingAddress (The
shipping address of the
customer);
 StatusId (The id of the
order status);
 Status (The order status
description).

Version: 2.0
 GetOrdersHeaders
Will return all orders headers for a given workflow step.

Key string A key provided by us so you can access this
information.
selectedStep string Wanted Order workflow step.
Available values:
 Step1
 Step2
 Step3

OrderWorkflowSte object Object with the definition of the order header.
pCommonStoreHe
Object properties:
aderDTO
<OrderWorkflowStepCommonStoreHeaderDTO>
<CustomerCPF>string</CustomerCPF>
<CustomerDDD>string</CustomerDDD>
<CustomerCityDD>int</CustomerCityDD>
<OrderId>int</OrderId>
<OrderCode>string</OrderCode>
<PointId>int</PointId>
<PointCode>string</PointCode>
<DateCreated>dateTime</DateCreated>
<CountryId>string</CountryId>
<ZoneEuro>boolean</ZoneEuro>
<PropInvoice>int</PropInvoice>
<ShipFromAddress>int</ShipFromAddress>
<IsPersonalShopper>boolean</IsPersonalShopper>
<CollectInStore>boolean</CollectInStore>
<CollectPoint>int</CollectPoint>
<Barcode>string</Barcode>
<CustomerEmail>string</CustomerEmail>
<CustomerAddress1>string</CustomerAddress1>
<CustomerAddress2>string</CustomerAddress2>
<CustomerCountry>string</CustomerCountry>
<CustomerCity>string</CustomerCity>
<CustomerState>string</CustomerState>
<CustomerZip>string</CustomerZip>
<CustomerPhone>string</CustomerPhone>
<CustomerCountryId>int</CustomerCountryId>
<CustomerNeighborhood>string</CustomerNeighborhood>
<CustomerNickName>string</CustomerNickName>
<CustomerMobile>string</CustomerMobile>
<BillingNickName>string</BillingNickName>
<BillingAddress1>string</BillingAddress1>
<BillingAddress2>string</BillingAddress2>
<BillingNeighborhood>string</BillingNeighborhood>
<BillingCountryId>int</BillingCountryId>
<BillingCountry>string</BillingCountry>
<BillingCity>string</BillingCity>
<BillingCityDD>int</BillingCityDD>
<BillingCPF>string</BillingCPF>
<BillingDDD>string</BillingDDD>
<BillingState>string</BillingState>
<BillingZip>string</BillingZip>
<BillingPhone>string</BillingPhone>
<BillingMobile>string</BillingMobile>
<BillingAddressNumber>string</BillingAddressNumber>
<BillingAddressComplement>string</BillingAddressComplement>
<CustomerAddressNumber>string</CustomerAddressNumber>
<CustomerAddressComplement>string</CustomerAddressComplement>´
<FilesUrl xsi:nil="true" />
<ItemsTotal>double</ItemsTotal>
<Shipping>double</Shipping>
<GrandTotal>double</GrandTotal>
<IsSameDay>boolean</IsSameDay>
<IsNextDay>boolean</IsNextDay>
</OrderWorkflowStepCommonStoreHeaderDTO>

Version: 2.0
 GetOrdersRows
Will return all products for a given order id.

information.
OrderId integer Order identifier.
Output Type Description Not

es
GetOrdersRowsRespo object Object with the definition of the order product.
nse Object properties:
<OrderWorkflowStepCommonStoreRowDTO>
<ArticleId>int</ArticleId>
<ArticleReference>string</ArticleReference>
<OrderLineId>int</OrderLineId>
<Quantity>int</Quantity>
<Size>string</Size>
<SizePosition>int</SizePosition>
<Price>double</Price>
<LineStatus>int</LineStatus>
<ShippingDescription>string</ShippingDescription>
<OrderFromPortal>int</OrderFromPortal>
<ShowWarning>boolean</ShowWarning>
<StoreSku>string</StoreSku>
<LogisticsDocPath>string</LogisticsDocPath>
<Ups>int</Ups>
<TrackingNumber>string</TrackingNumber>
<BoxName>string</BoxName>
<BoxVolWeight>decimal</BoxVolWeight>
<IsDuplicate>int</IsDuplicate>
<Total>double</Total>
<Reason>string</Reason>
<ReasonNotes>string</ReasonNotes>
<ReturnOrderId>int</ReturnOrderId>
<Scale>string</Scale>
<ImageUrl>string</ImageUrl>
<StoreBarcode>string</StoreBarcode>
<StoreTotalDDP>double</StoreTotalDDP>
<DiscountPromocode>double</DiscountPromocode>
<ItemBasePrice>double</ItemBasePrice>
<ItemBaseVat>double</ItemBaseVat>
<TotalVatDiscount>double</TotalVatDiscount>
<CustomizationDetails>string</CustomizationDetails>
</OrderWorkflowStepCommonStoreRowDTO>

Version: 2.0
 GetPackages
Will return all packages available for the partner.

information.

es
GetPackagesResult object Object with the definition of the packages.
Object properties:
<Box>
<Id>int</Id>
<Description>string</Description>
</Box>
 GetReturns
Will return the order return information

information.

GetReturnsResponse List of List of object with the definition of the return.
object
Object properties:
<OrderId>int</OrderId>
<OrderCode>string</OrderCode>
<PointId>int</PointId>
<PointCode>string</PointCode>
<DateCreated>dateTime</DateCreated>
<OrderLines>
<ReturnOrderLineDto xsi:nil="true" />
<ReturnOrderLineDto xsi:nil="true" />
</OrderLines>
<CountryId>string</CountryId>
<ZoneEuro>boolean</ZoneEuro>
<PropInvoice>int</PropInvoice>
<ShipFromAddress>int</ShipFromAddress>
<IsPersonalShopper>int</IsPersonalShopper>
<CollectInStore>boolean</CollectInStore>
<CollectPoint>int</CollectPoint>
<Barcode>string</Barcode>
<Status>int</Status>

Version: 2.0
 GetStockByBarcode
N/A

Version: 2.0
 GetStockBySize
Will return the amount of stock for a given size of a given article id.

information.
ItemID Long The article id.
Size String The size.

it occurs.
GetStockBySizeResult Integer The amount of stock

Version: 2.0
 GetShippingAddress
Will return the shipping address from order.

information.
OrderID String The order identifier.

occurs.
GetShippingAddressResult Class Containing the following fields:
 IdAddress (The address
ID);
 CheckoutOrderId (The
Checkout ID);
 Name (The address name);
 AddressLine1 (The address
line 1 value);
 AddressLine2 (The
addressLine2 value);
 Zip (The address zip code);
 City (The address city);
 CityID (The city ID);
 Country (The address
country);
 State (The address state);
 Phone (The phone contact
for the address);
 SetShippingAddress
Will update the order shipping address.

information.
OrderID String The order identifier to be updated.
AddressID String The new shipping address identifier.

occurs.
SetShippingAddressResult Boolean  Operation result. True if
it has been updated
successfully, false if it
has not been updated.

Version: 2.0
 ItemIDProcess
Will add an amount of stock of a given article id. If the amount is negative, it will
remove that amount from the stock.

information.
Qty Integer The amount of stock to add. (Negative value if

you want to remove.
movement (ex: insert or remove stock).

it occurs.
ItemIDProcessResult Boolean True if it was a successful call.

Version: 2.0
 ItemIDProcessAbsoluteQuantity
Will set the absolute quantity of stock to a given article id.

information.
AbsoluteQty Integer The amount of stock to add (Negative values are

not allowed).
movement.

it occurs.
ItemIDProcessResult Boolean True if it was a successful call.

Version: 2.0
 OrderStatusUpdate
N/A

Version: 2.0
 SendOrderStep1toStep2
N/A

Version: 2.0
 SendOrderStep3toStep4
N/A

Version: 2.0
 SendOrderStep3toStep4WithPackages
Will send the order from 3 to 4 with packaging information.

information.
OrderId Integer Order identifier.
OrderLines List of object Object with the list os order lines to set the
packages.
OrderLine Id and Box Id mandatory.
Default Box Quantity is 1.
<OrderLine>
<Id>int</Id>
<Box>
<Id>int</Id>
<Description>string</Description>
<Quantity>int</Quantity>
</Box>
</OrderLine>

es
SendOrderStep3toSte Boolean True if it was a successful call.
p4WithPackagesResul False if it wasn’t.
t
 StockCompare
N/A

Version: 2.0
 ValidateReturn
Validates the return (Accept / Refuse).

information.
OrderId Integer The order identifier.
ReturnStatus object AcceptWithShippingCost or
AcceptWithoutShippingCost or Refuse

es
ValidateReturnResult Boolean True if it was a successful call.

Version: 2.0

Farfetch API Manual

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Farfetch API Manual

Uploaded by

Copyright:

Available Formats

FARFETCH

API Technical Manual

Dept.: Back Office

API Technical Manual

Endpoints and sandbox

API Technical Manual

API Technical Manual

API Technical Manual

Parameter Type Description

CurrentStock Integer Total stock of the product.

Output Type Description Notes

API Technical Manual

Parameter Type Description

Output Type Description Notes

API Technical Manual

Parameter Type Description

Output Type Description Notes

API Technical Manual

Parameter Type Description

Output Type Description Notes

API Technical Manual

Parameter Type Description

Output Type Description Notes

API Technical Manual

Parameter Type Description

Year Integer The year number

Output Type Description Notes

API Technical Manual

Parameter Type Description

Output Type Description Notes

API Technical Manual

Will return the item id given the following parameters:

Parameter Type Description

DesignerId String The id of the designer associated with the item.

SKU String The SKU associated with the article.

Output Type Description Notes

API Technical Manual

Get all invoices between two dates in an xml format.

Next request: FF returns invoices A132, A145, A576, A689, A888

Parameter Type Description

To DateTime End date of range.

Output Type Description Notes

API Technical Manual

Parameter Type Description

ErrMsg String A message that will return the error, if it occurs.

Output Type Description Notes

API Technical Manual

Parameter Type Description

EndDate Datetime The date of when the search period ends.

Output Type Description Notes

API Technical Manual

Will return all orders headers for a given workflow step.

Parameter Type Description

Output Type Description Notes

API Technical Manual

Parameter Type Description

Output Type Description Not

API Technical Manual

Parameter Type Description

Output Type Description Not

Parameter Type Description

Output Type Description Notes