PHPackages                             fieldnation/fieldnation-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. fieldnation/fieldnation-sdk

ActiveLibrary

fieldnation/fieldnation-sdk
===========================

An SDK to Get Work Done

1.1.0(8y ago)42852[3 issues](https://github.com/fieldnation/fieldnation-sdk-php/issues)Apache-2.0PHP

Since Mar 6Pushed 7y ago45 watchersCompare

[ Source](https://github.com/fieldnation/fieldnation-sdk-php)[ Packagist](https://packagist.org/packages/fieldnation/fieldnation-sdk)[ RSS](/packages/fieldnation-fieldnation-sdk/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (5)Used By (0)

WE do not support SOAP API for new developement, This code is for reference only
================================================================================

[](#we-do-not-support-soap-api-for-new-developement-this-code-is-for-reference-only)

[![Field Nation Logo](images/logo.png)](images/logo.png)

Field Nation PHP SDK
====================

[](#field-nation-php-sdk)

- [Build Status](#build-status)
- [Installation](#installation)
    - [PHP Support](#php-support)
    - [PHP Requirements](#php-requirements)
    - [Installation with Composer](#installation-with-composer)
- [Usage](#usage)
    - [Authentication](#authentication)
    - [Environment](#environment)
    - [Create a Work Order](#create-a-work-order)
    - [Work Order Actions and Metadata](#work-order-actions)
        - [Publish](#publish)
        - [Route to Provider](#route-to-provider)
        - [Route to Group](#route-to-group)
        - [Approve](#approve)
        - [Cancel](#cancel)
        - [Attach Documents](#attach-documents)
        - [Detach Documents](#detach-documents)
        - [Add a Message](#add-a-message)
        - [Add a Custom Field](#add-a-custom-field)
        - [Add a Label](#add-a-label)
        - [Remove a Label](#remove-a-label)
        - [Resolving a Closeout Requirements](#resolving-a-closeout-requirements)
        - [Add a Shipment](#add-a-shipment)
        - [Delete a Shipment](#delete-a-shipment)
        - [Update Schedule](#update-schedule)
        - [Get the Entire Work Order](#get-the-entire-work-order)
        - [Get the Status](#get-the-status)
        - [Get the Assigned Provider](#get-the-assigned-provider)
        - [Get Progress](#get-progress)
        - [Get Payment](#get-payment)
        - [Get Messages](#get-messages)
        - [Get Attached Documents](#get-attached-documents)
        - [Get Shipments](#get-shipments)
    - [Get Your Work Orders](#get-your-work-orders)
    - [Get Your Projects](#get-your-projects)
    - [Get Your Documents](#get-your-documents)
    - [Convert a Tracking Number to a Shipping ID](#convert-a-tracking-number-to-a-shipping-id)
    - [Using Your Classes](#using-your-classes)
- [Contributing](#contributing)
    - [Tests](#tests)
    - [Coding Standards](#coding-standards)
- [Changelog](#changelog)
- [License](#license)

Build Status
------------

[](#build-status)

[![Build Status](https://camo.githubusercontent.com/2c11e9bf6bd41eb14ae76d98bb8b092ea8f07aa20253e7db92869bd8d839de03/68747470733a2f2f6a6e6b6e732e666e6465762e6e65742f6a6f622f6669656c646e6174696f6e2d7068702d73646b2f62616467652f69636f6e)](https://jnkns.fndev.net/job/fieldnation-php-sdk/)

Installation
------------

[](#installation)

### PHP Support

[](#php-support)

- PHP 5.6+
- PHP 7+
- HHVM

### PHP Requirements

[](#php-requirements)

Your php runtime needs to have [Soap](http://php.net/manual/en/book.soap.php) enabled. Follow the [installation instructions](http://php.net/manual/en/soap.setup.php) for enabling the Soap module.

### Installation with Composer

[](#installation-with-composer)

Require the `fieldnation/fieldnation-sdk` package in your project.

```
$ composer require fieldnation/fieldnation-sdk
```

Usage
-----

[](#usage)

The key concept to successfully integrating with Field Nation is describing how your business objects become Field Nation objects. We provide interfaces for describing how your data can be created on Field Nation.

### Authentication

[](#authentication)

To use the SDK you need to generate an API key for your company. You can create an API key at `https://app.fieldnation.com/api`. Once you have a key you can create a connection.

```