transferOrder

Retrieve a single transfer order by its internal ID.

Required scope: view_transfer_orders

---

Query

query GetTransferOrder($id: String!) {
  transferOrder(id: $id) {
    id
    reference
    orderNumber
    state
    externalReference
    expectedDate
    shippingDate
    carrier
    tracking
    comment
    emergency
    containerNumber
    containerType
    location {
      id
      name
    }
    lines {
      id
      sku
      reference
      expectedQuantity
      receivedQuantity
      restockedQuantity
      garbageQuantity
      limitUsageDate
      batchNumber
      transferOrderLineNumber
      state
    }
    events {
      id
      type
      message
      date
    }
    fulfillments {
      id
      state
      createdAt
      issuedAt
      lines {
        id
      }
    }
    createdAt
    updatedAt
  }
}

---

Arguments

Argument	Type	Required	Description
id	String	✅	The internal UUID of the transfer order

---

Example Variables

{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

---

Example Response

{
  "data": {
    "transferOrder": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "reference": "TO-2024-001",
      "orderNumber": "ACME-TO-000042",
      "state": "OPENED",
      "externalReference": "ERP-TRANSFER-789",
      "expectedDate": "2024-02-15T08:00:00.000Z",
      "shippingDate": "2024-02-12T10:00:00.000Z",
      "carrier": "DHL Express",
      "tracking": "1Z999AA10123456784",
      "comment": "Fragile items — handle with care",
      "emergency": false,
      "containerNumber": "3",
      "containerType": "BOX",
      "location": {
        "id": "loc-uuid-001",
        "name": "Paris Warehouse"
      },
      "lines": [
        {
          "id": "line-uuid-001",
          "sku": "WIDGET-A-100",
          "reference": "Widget Alpha",
          "expectedQuantity": 500,
          "receivedQuantity": 0,
          "restockedQuantity": 0,
          "garbageQuantity": 0,
          "limitUsageDate": null,
          "batchNumber": "BATCH-2024-01",
          "transferOrderLineNumber": "ACME-TO-000042-001",
          "state": "ACTIVE"
        }
      ],
      "events": [
        {
          "id": "evt-uuid-001",
          "type": "FULFILLMENT_ACCEPTED",
          "message": "Transfer order accepted by warehouse",
          "date": "2024-02-10T14:30:00.000Z"
        }
      ],
      "fulfillments": [],
      "createdAt": "2024-02-10T09:00:00.000Z",
      "updatedAt": "2024-02-10T14:30:00.000Z"
    }
  }
}

---

Code Examples

curl

curl -X POST https://api-v3.happycolis.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -d '{
    "query": "query GetTransferOrder($id: String!) { transferOrder(id: $id) { id reference orderNumber state externalReference expectedDate containerType lines { id sku reference expectedQuantity receivedQuantity state } events { id type message date } createdAt } }",
    "variables": {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    }
  }'

Node.js

const response = await fetch('https://api-v3.happycolis.com/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${process.env.ACCESS_TOKEN}`,
  },
  body: JSON.stringify({
    query: `
      query GetTransferOrder($id: String!) {
        transferOrder(id: $id) {
          id
          reference
          orderNumber
          state
          externalReference
          expectedDate
          containerType
          lines {
            id
            sku
            reference
            expectedQuantity
            receivedQuantity
            state
          }
          events {
            id
            type
            message
            date
          }
          createdAt
        }
      }
    `,
    variables: {
      id: '550e8400-e29b-41d4-a716-446655440000',
    },
  }),
});

const { data } = await response.json();
console.log(data.transferOrder);

Python

import os
import requests

query = """
query GetTransferOrder($id: String!) {
  transferOrder(id: $id) {
    id
    reference
    orderNumber
    state
    externalReference
    expectedDate
    containerType
    lines {
      id
      sku
      reference
      expectedQuantity
      receivedQuantity
      state
    }
    events {
      id
      type
      message
      date
    }
    createdAt
  }
}
"""

response = requests.post(
    'https://api-v3.happycolis.com/graphql',
    headers={
        'Authorization': f'Bearer {os.environ["ACCESS_TOKEN"]}',
    },
    json={
        'query': query,
        'variables': {
            'id': '550e8400-e29b-41d4-a716-446655440000',
        },
    },
)

data = response.json()['data']
print(data['transferOrder'])

PHP

<?php
$query = <<<'GQL'
query GetTransferOrder($id: String!) {
  transferOrder(id: $id) {
    id
    reference
    orderNumber
    state
    externalReference
    expectedDate
    containerType
    lines {
      id
      sku
      reference
      expectedQuantity
      receivedQuantity
      state
    }
    events {
      id
      type
      message
      date
    }
    createdAt
  }
}
GQL;

$payload = json_encode([
    'query'     => $query,
    'variables' => ['id' => '550e8400-e29b-41d4-a716-446655440000'],
]);

$ch = curl_init('https://api-v3.happycolis.com/graphql');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST           => true,
    CURLOPT_POSTFIELDS     => $payload,
    CURLOPT_HTTPHEADER     => [
        'Content-Type: application/json',
        'Authorization: Bearer ' . getenv('ACCESS_TOKEN'),
    ],
]);

$result = json_decode(curl_exec($ch), true);
curl_close($ch);

print_r($result['data']['transferOrder']);

Go

package main

import (
	"bytes"
	"encoding/json"
	"fmt"
	"net/http"
	"os"
)

func main() {
	query := `
		query GetTransferOrder($id: String!) {
			transferOrder(id: $id) {
				id
				reference
				orderNumber
				state
				externalReference
				expectedDate
				containerType
				lines {
					id
					sku
					reference
					expectedQuantity
					receivedQuantity
					state
				}
				events {
					id
					type
					message
					date
				}
				createdAt
			}
		}`

	body, _ := json.Marshal(map[string]any{
		"query":     query,
		"variables": map[string]any{"id": "550e8400-e29b-41d4-a716-446655440000"},
	})

	req, _ := http.NewRequest("POST", "https://api-v3.happycolis.com/graphql", bytes.NewBuffer(body))
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ACCESS_TOKEN"))

	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()

	var result map[string]any
	json.NewDecoder(resp.Body).Decode(&result)
	fmt.Println(result["data"])
}