# Inventory Transfer API

## Creating transfer

You can create product transfers with this function.

| Field       | Required? | Description                                       |
| ----------- | --------- | ------------------------------------------------- |
| `apiKey`    | Yes       | API key                                           |
| `direction` | Yes       | Direction of transfer in creation (in/out)        |
| `note`      | No        | Note for transfer                                 |
| `date`      | Yes       | Date of expected transfer                         |
| `quantity`  | Yes       | Quantity of product transfered (positive integer) |
| `sku`       | Yes       | Sku of product transfered                         |

In case of **XML**:

Url: `https://app.webshippy.com/wspyapi/CreateTransfer/xml`

Request:

```
<?xml version="1.0" encoding="utf-8"?>
<request>
 <apiKey>api-key-comes-here</apiKey>
 <transfer>
     <direction>in</direction>
     <note>délután érkezik</note>
     <date>2018-01-01</date>
     <products>
       <elem>
         <quantity>3</quantity>
         <sku>4345</sku>
       </elem>
       <elem>
         <quantity>1</quantity>
         <sku>67657</sku>
       </elem>
       <elem>
         <quantity>1</quantity>
         <sku>56464</sku>
       </elem>
     </products>
 </transfer>
</request>
```

Response (example):

```
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>success</status>
  <message>
    <elem>The transfer creation was successful</elem>
  </message>
  <transfer_id>74210</transfer_id>
</response>
```

In case of **JSON**:

Url: `https://app.webshippy.com/wspyapi/CreateTransfer/json`

Request:

```
{
  "apiKey": "api-key-comes-here",
  "transfer": {
  "direction": "in",
  "transfer_id": 59,
  "note": "délután viszik el",
  "date": "2018-08-20",
  "products": [
   {
     "quantity": 3,
     "sku": 343545
   },
   {
     "quantity": 2,
     "sku": 654564
   },
   {
     "quantity": 1,
     "sku": 32432432
   }
   ]
 }
}

```

Response (example):

```
{
  "status": "success",
  "message": [
    "The transfer creation was successful"
  ],
  "transfer_id": 176
}
```

```
```

Request:

Url: `https://app.webshippy.com/wspyapi/CreateTransfer/json`

In case of **JSON**:

```
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>success</status>
  <message>
    <elem>The transfer creation was successful</elem>
  </message>
  <transfer_id>74210</transfer_id>
</response>
```

Response (example):

```
<?xml version="1.0" encoding="utf-8"?>
<request>
 <apiKey>api-key-comes-here</apiKey>
 <transfer>
     <direction>in</direction>
     <note>délután érkezik</note>
     <date>2018-01-01</date>
     <products>
       <elem>
         <quantity>3</quantity>
         <sku>4345</sku>
       </elem>
       <elem>
         <quantity>1</quantity>
         <sku>67657</sku>
       </elem>
       <elem>
         <quantity>1</quantity>
         <sku>56464</sku>
       </elem>
     </products>
 </transfer>
</request>
```

Request:

Url: `https://app.webshippy.com/wspyapi/CreateTransfer/xml`

## Requesting transfer details

| Field     | Required? | Description                                                                                   |
| --------- | --------- | --------------------------------------------------------------------------------------------- |
| `apiKey`  | Yes       | API key                                                                                       |
| `limit`   | No        | Hits within a page (default: 100, maximum: 1000)                                              |
| `page`    | No        | Number of the requested page (default: 0)                                                     |
| `lastMod` | No        | Last modification's date. Lists even several created or modified orders after the given date. |
| `wspyId`  | No        | Transfer's unique Webshippy ID                                                                |

In case of **XML**:

Url: `https://app.webshippy.com/wspyapi/getTransfer/xml`

Request:

```
<?xml version="1.0" encoding="utf-8"?>
<request>
 <apiKey>api-key-comes-here</apiKey>
 <page>0</page>
 <limit>1000</limit>
 <filters>
     <wspyId></wspyId>
     <lastMod>2019-01-01 00:00:00</lastMod>
 </filters>
</request>
```

Response (example):

```
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>success</status>
  <message/>
  <result>
    <elem>
      <wspyId>7258</wspyId>
      <warehouseId/>
      <status>shipped</status>
      <direction>in</direction>
      <expectedArrival>2019-07-24</expectedArrival>
      <note>t-takács</note>
      <created>2019-07-23 10:54:33</created>
      <updated>2019-07-24 07:24:10</updated>
      <new>2019-07-23 11:51:25</new>
      <arrived>2019-07-24 07:28:57</arrived>
      <transfered>2019-07-24 07:30:45</transfered>
    </elem>
  </result>
</response>
```

In case of **JSON**:

Url: `https://app.webshippy.com/wspyapi/getTransfer/json`

Request:

```
{
  "apiKey": "api-key-comes-here",
  "page": "0",
  "limit": "1000",
  "filters": {
    "wspyId": "",
    "lastMod": "2019-01-01 00:00:00"
  }
}
```

Response (example):

```
{
    "status": "success",
    "message": [],
    "result": [
        {
            "wspyId": "7258",
            "warehouseId": null,
            "status": "shipped",
            "direction": "in",
            "expectedArrival": "2019-07-24",
            "note": "t-takács",
            "created": "2019-07-23 10:54:33",
            "updated": "2019-07-24 07:24:10",
            "new": "2019-07-23 11:51:25",
            "arrived": "2019-07-24 07:28:57",
            "transfered": "2019-07-24 07:30:45"
        }
    ]
}
```

## Requesting a transfer's items

| Field    | Required? | Description                    |
| -------- | --------- | ------------------------------ |
| `apiKey` | Yes       | API key                        |
| `wspyId` | Yes       | Transfer's unique Webshippy ID |

In case of **XML**:

Url: `https://app.webshippy.com/wspyapi/getTransferDetails/xml`

Request:

```
<?xml version="1.0" encoding="utf-8"?>
<request>
 <apiKey>api-key-comes-here</apiKey>
 <filters>
     <wspyId>6526</wspyId>
 </filters>
</request>
```

Response (example):

```
<?xml version="1.0" encoding="utf-8"?>
<response>
  <status>success</status>
  <message/>
  <result>
    <elem>
      <wspyProductId>267812</wspyProductId>
      <productName>Teszt termék 2</productName>
      <variantName/>
      <produtSku>TESZT-2</produtSku>
      <productBarcode>TESZT-2</productBarcode>
      <quantity>10</quantity>
      <checkedQuantity>15</checkedQuantity>
    </elem>
  </result>
</response>
```

In case of **JSON**:

Url: `https://app.webshippy.com/wspyapi/getTransferDetails/json`

Request:

```
{
  "apiKey": "api-key-comes-here",
  "filters": {
    "wspyId": "6526"
  }
}
```

Response (example):

```
{
    "status": "success",
    "message": [],
    "result": [
        {
            "wspyProductId": "267812",
            "productName": "Teszt termék 2",
            "variantName": "",
            "produtSku": "TESZT-2",
            "productBarcode": "TESZT-2",
            "quantity": "10",
            "checkedQuantity": "15"
        }
    ]
}
```