Fusion Operations API

Authorization  ¶

Authorization Resource represents an authorization granted to the company. You can only access your own authorization. The authentication used is Basic authentication, where the Authentication header is on the form <base64 encoded value of API_KEY:API_SECRET>. To get the API Key and Secret, login to Fusion Operations and edit your user. (Note: you have to have admin role to get it). The Authorization Resource has the following attribute:

• token

• scopes

Where token represents a token and scopes is an array of scopes granted for the given authorization. At this moment the only available scope is productions_write.

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Content-Type: application/hal+json
Link: <https://fusionoperations.autodesk.com/api/authorizations>;rel="self"

{
      "_links": {
          "self": { "href": "/api/authorizations" },
      },
      "scopes": [
          "productions_write"
      ],
      "token": "abc123"
  }

Content-Type: application/json
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

{
  "scopes": [
    "productions_write"
  ]
}

Content-Type: application/hal+json
Link: <https://fusionoperations.autodesk.com/api/authorizations>;rel="self"

{
      "_links": {
          "self": { "href": "/api/authorizations" },
      },
      "scopes": [
          "productions_write"
      ],
      "token": "abc123"
  }

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Supplier  ¶

A single Supplier object.

The Supplier resource has the following attributes:

• id (supplied)

• code (string, required, unique) - supplier code

• name (string, required) - supplier name

• number (string, optional) - supplier VAT number

• expiration-date (date, optional, format YYYY-MM-DDTHH:MM:SSZ) - date when the supplier expires

• addresses (array, optional)

  • code (string, required, unique) - address code
  • name (string, optional) - address name
  • address (string, required) - address line
  • city (string, optional) - address city
  • post-code (string, optional) - address post code
  • state (string, optional) - address state/region
  • country (string, required) - address country code
  • default (boolean, optional - defaults to false) - if true, it’s the supplier default address

• contacts (array, optional)

  • phone-number (string, required if there is no email) - contact phone number
  • email (string, required if there is no phone-number) - contact email
  • name (string, optional) - contact name
  • default (boolean, optional - defaults to false) - if true, it’s the supplier default contact

Default address/contact rules:

• Both the contacts and addresses can only have one default contact or address, respectively

• If a supplier has addresses, one of the addresses needs to be the default one

• If a supplier has contacts, one of the contacts needs to be the default one

• In creation/update of a supplier, if no default contact/address is given, the first contact/address is going to be the default one

Content-Type: application/json

{
  "code": "Supplier",
  "name": "Supplier",
  "number": "213456",
  "expiration-date": "2020-01-01T00:00:00Z",
  "contacts": [
    {
      "email": "supplier@supplier.com",
      "phone-number": "12345678",
      "name": "Contact1",
      "default": true
    },
    {
      "email": "supplier2@supplier2.com",
      "phone-number": "123456789",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "city": "Lisbon",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "city": "San Francisco",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

{
  "id": 987356123,
  "code": "Supplier",
  "name": "Supplier",
  "number": "213456",
  "expiration-date": "01/01/2020",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "address": "Address 1 Street",
      "city": "Lisbon",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "address": "Address 1 Street",
      "city": "San Francisco",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

[
  {
    "id": 987356123,
    "code": "Supplier",
    "name": "Supplier",
    "number": "213456",
    "expiration-date": "01/01/2020",
    "contacts": [
      {
        "phone-number": "12345678",
        "email": "supplier@supplier.com",
        "name": "Contact1",
        "default": true
      },
      {
        "phone-number": "123456789",
        "email": "supplier2@supplier2.com",
        "name": "Contact2",
        "default": false
      }
    ],
    "addresses": [
      {
        "code": "Address1",
        "name": "Address1",
        "address": "Address 1 Street",
        "city": "Lisbon",
        "post-code": "111-111",
        "state": "Lisbon",
        "country": "PT",
        "default": true
      },
      {
        "code": "Address2",
        "name": "Address2",
        "address": "Address 1 Street",
        "city": "San Francisco",
        "post-code": "111-111",
        "state": "California",
        "country": "US",
        "default": false
      }
    ]
  },
  {
    "id": 987356124,
    "code": "Supplier2",
    "name": "Supplier2",
    "number": "213457",
    "expiration-date": "01/01/2020",
    "contacts": [
      {
        "phone-number": "12345678",
        "email": "supplier3@supplier3.com",
        "name": "Contact1",
        "default": true
      },
      {
        "phone-number": "123456789",
        "email": "supplier4@supplier4.com",
        "name": "Contact2",
        "default": false
      }
    ],
    "addresses": [
      {
        "code": "Address3",
        "name": "Address3",
        "address": "Address 3 Street",
        "city": "Paris",
        "post-code": "111-111",
        "state": "Paris",
        "country": "FR",
        "default": true
      },
      {
        "code": "Address4",
        "name": "Address4",
        "address": "Address 4 Street",
        "city": "Madrid",
        "post-code": "111-111",
        "state": "Madrid",
        "country": "ES",
        "default": false
      }
    ]
  }
]

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "id": 987356123,
  "code": "Supplier",
  "name": "Supplier",
  "number": "213456",
  "expiration-date": "01/01/2020",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "address": "Address 1 Street",
      "city": "Lisbon",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "address": "Address 1 Street",
      "city": "San Francisco",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "code": "Supplier",
  "name": "Supplier",
  "number": "213456",
  "expiration-date": "2020-01-01T00:00:00Z",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "address": "Address 1 Street",
      "city": "Lisbon",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "address": "Address 1 Street",
      "city": "San Francisco",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

{
  "code": "Supplier",
  "name": "Supplier",
  "number": "213456",
  "expiration-date": "01/01/2020",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "address": "Address 1 Street",
      "city": "Lisbon",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "address": "Address 1 Street",
      "city": "San Francisco",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Supplier was deleted

It's not possible to delete this supplier. It has dependent entities.

Client  ¶

A single Client object.

The Client resource has the following attributes:

• id (supplied)

• code (string, required, unique) - client code

• name (string, required) - client name

• number (string, optional) - client number

• phone-number (string, optional) - client phone number

• email (string, optional) - client email

• addresses (array, optional)

  • code (string, required, unique) - address code
  • name (string, optional) - address name
  • address (string, required) - address line
  • city (string, optional) - address city
  • post-code (string, optional) - address post code
  • state (string, optional) - address state/region
  • country (string, required) - address country code
  • default (boolean, optional - defaults to false) - if true, it’s the client default address

• contacts (array, optional)

  • phone-number (string, required if there is no email) - contact phone number
  • email (string, required if there is no phone-number) - contact email
  • name (string, optional) - contact name
  • default (boolean, optional - defaults to false) - if true, it’s the client default contact

Default address/contact rules:

• Both the contacts and addresses can only have one default contact or address, respectively

• If a client has addresses, one of the addresses needs to be the default one

• If a client has contacts, one of the contacts needs to be the default one

• In creation/update of a client, if no default contact/address is given, the first contact/address is going to be the default one

Content-Type: application/json

{
  "code": "Client",
  "name": "Client",
  "number": "213456",
  "email": "client@client.com",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "city": "Lisbon",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "city": "San Francisco",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

{
  "id": 987356123,
  "code": "Client",
  "name": "Client",
  "number": "213456",
  "email": "client@client.com",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "city": "Lisbon",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "city": "San Francisco",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

[
  {
    "id": 987356123,
    "code": "Client",
    "name": "Client",
    "number": "213456",
    "phone-number": "12345678",
    "email": "client@client.com",
    "contacts": [
      {
        "phone-number": "12345678",
        "email": "supplier@supplier.com",
        "name": "Contact1",
        "default": true
      },
      {
        "phone-number": "123456789",
        "email": "supplier2@supplier2.com",
        "name": "Contact2",
        "default": false
      }
    ],
    "addresses": [
      {
        "code": "Address1",
        "name": "Address1",
        "city": "Lisbon",
        "address": "Address 1 Street",
        "post-code": "111-111",
        "state": "Lisbon",
        "country": "PT",
        "default": true
      }
    ]
  },
  {
    "id": 987356124,
    "code": "Client2",
    "name": "Client2",
    "number": "2213457",
    "phone-number": "12345678",
    "email": "client2@client2.com",
    "contacts": [
      {
        "phone-number": "12345678",
        "email": "supplier@supplier.com",
        "name": "Contact1",
        "default": true
      }
    ],
    "addresses": [
      {
        "code": "Address2",
        "name": "Address2",
        "city": "San Francisco",
        "address": "Address 1 Street",
        "post-code": "111-111",
        "state": "California",
        "country": "US",
        "default": true
      }
    ]
  }
]

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "id": 987356123,
  "code": "Client",
  "name": "Client",
  "number": "213456",
  "phone-number": "12345678",
  "email": "client@client.com",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address1",
      "name": "Address1",
      "city": "Lisbon",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "Lisbon",
      "country": "PT",
      "default": true
    },
    {
      "code": "Address2",
      "name": "Address2",
      "city": "San Francisco",
      "address": "Address 1 Street",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": false
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "code": "Client",
  "name": "Client",
  "number": "213456",
  "phone-number": "12345678",
  "email": "client@client.com",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address3",
      "name": "Address3",
      "city": "Los Angeles",
      "address": "Address 3 Street",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": true
    }
  ]
}

{
  "id": 987356123,
  "code": "Client",
  "name": "Client",
  "number": "213456",
  "phone-number": "12345678",
  "email": "client@client.com",
  "contacts": [
    {
      "phone-number": "12345678",
      "email": "supplier@supplier.com",
      "name": "Contact1",
      "default": true
    },
    {
      "phone-number": "123456789",
      "email": "supplier2@supplier2.com",
      "name": "Contact2",
      "default": false
    }
  ],
  "addresses": [
    {
      "code": "Address3",
      "name": "Address3",
      "city": "Los Angeles",
      "address": "Address 3 Street",
      "post-code": "111-111",
      "state": "California",
      "country": "US",
      "default": true
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Client was deleted

It's not possible to delete this client. It has dependent entities.

Sales Order  ¶

A single Sales Order object. The Sales Order resource is one of the most important resources of the Fusion Operations API.

The Sales Order resource has the following attributes:

• id (supplied)

• code (string, required) - sales order code

• client (string, optional) - client code

• observations (string, optional) - sales order observations

• products (array, required, not empty)

  • code (string, required, unique) - product code
  • quantity (double, required, >0) - quantity ordered
  • due-date (date, optional, format YYYY-MM-DDTHH:MM:SSZ) - date when the shipping is due
  • requested-date (date, optional, format YYYY-MM-DDTHH:MM:SSZ) - date when the shipping is requested
  • location (string, optional) - location, if multisite
  • price (double, optional) - product price

Content-Type: application/json

{
  "code": "CO123 - Week 47",
   "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "billing-address": "Billing address code",
  "delivery-address": "Delivery address code",
  "products": [
    {
      "code": "V23076",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "location": "location code",
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 150.0,
      "location": "location code",
    }
  ]
}

{
  "id": 987356123,
  "code": "CO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "name": "Vessel",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "location": {
        "id": "location id",
        "code": "location code",
        "name": "location name"
      }
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 150,
      "location": {
        "id": "location id",
        "code": "location code",
        "name": "location name"
      }
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

[
  {
    "id": 987356123,
    "code": "CO123 - Week 47",
    "creation-date": "2022-04-19T08:30:01Z",
    "client": "Client X",
    "observations": "Ready next week",
    "products": [
      {
        "code": "V23076",
        "name": "Vessel",
        "quantity": 100,
        "due-date": "2019-08-16T17:15:15Z",
        "requested-date": "2019-01-16T15:19:54Z",
        "price": 200.3,
        "location": {
          "id": "location id",
          "code": "location code",
          "name": "location name"
        }
      },
      {
        "code": "V23077",
        "quantity": 99,
        "due-date": "2016-08-16T17:15:15Z",
        "requested-date": "2019-01-16T15:19:54Z",
        "price": 150,
        "location": {
          "id": "location id",
          "code": "location code",
          "name": "location name"
        }
      }
    ]
  },
  {
    "id": 987356124,
    "code": "CO123 - Week 48",
    "client": "Client X",
    "observations": "",
    "products": [
      {
        "code": "V23076",
        "name": "Vessel",
        "quantity": 70,
        "due-date": "2019-08-23T18:00:00Z",
        "requested-date": "2019-01-16T15:19:54Z",
        "price": 140,
        "location": {
          "id": "location id",
          "code": "location code",
          "name": "location name"
        }
      },
      {
        "code": "V23077",
        "quantity": 69,
        "due-date": "2016-08-23T18:00:00Z",
        "requested-date": "2019-01-16T15:19:54Z",
        "price": 150,
        "location": {
          "id": "location id",
          "code": "location code",
          "name": "location name"
        }
      }
    ]
  }
]

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "id": 987356123,
  "code": "CO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "name": "Vessel",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "location": {
        "id": "location id",
        "code": "location code",
        "name": "location name"
      }
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 150,
      "location": {
        "id": "location id",
        "code": "location code",
        "name": "location name"
      }
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "code": "CO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "location": "location code",
  "products": [
    {
      "code": "V23076",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "location": "location code"
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "location": "location code"
    }
  ]
}

{
  "id": 987356123,
  "code": "CO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "name": "Vessel",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "location": {
        "id": "location id",
        "code": "location code",
        "name": "location name"
      }
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "location": {
        "id": "location id",
        "code": "location code",
        "name": "location name"
      }
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Sales order was deleted

Sales order already has production orders created or other entities associated, cannot be removed.

Purchase Order  ¶

A single Purchase Order object. The Purchase Order resource is one of the most important resources of the Fusion Operations API.

The Purchase Order resource has the following attributes:

• id (supplied)

• code (string, required) - purchase order code

• supplier (string, optional) - supplier code

• billing-address (string, optional) - billing address

• observations (string, optional) - purchase order observations

• products (array, required, not empty)

  • code (string, required, unique) - product code
  • quantity (double, required, >0) - quantity request
  • due-date (date, optional, format YYYY-MM-DDTHH:MM:SSZ) - date when the receiving is due
  • requested-date (date, optional, format YYYY-MM-DDTHH:MM:SSZ) - date when the receiving is requested
  • cost (double, optional) - product cost
  • uom (string, optional) - product unit of measurement
  • delivery-address (string, optional) - receiving delivery address

• parameters (string, optional) - purchase order parameters

• approval-status (string, optional) - draft, in review, approved, confirmed, rejected

Content-Type: application/json

{
  "code": "PO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "supplier": "Supplier X",
  "billing-address": "Lisbon",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "uom": "Box",
      "cost": 200.3,
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ]
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z"
    }
  ],
  "approval-status": "draft",
  "active": true
}

{
  "id": 987356123,
  "code": "PO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "supplier": "Supplier X",
  "billing-address": "Lisbon",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "name": "Vessel",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "uom": "Box",
      "cost": 200.3,
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ]
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z"
    }
  ],
  "approval-status": "draft"
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "id": 987356123,
  "code": "PO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "supplier": "Supplier X",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "name": "Vessel",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "cost": 200.3
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z"
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "code": "CO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ]
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z"
    }
  ],
  "active": true
}

{
  "id": 987356123,
  "code": "CO123 - Week 47",
  "creation-date": "2022-04-19T08:30:01Z",
  "client": "Client X",
  "observations": "Ready next week",
  "products": [
    {
      "code": "V23076",
      "name": "Vessel",
      "quantity": 100,
      "due-date": "2019-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z",
      "price": 200.3,
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ]
    },
    {
      "code": "V23077",
      "quantity": 99,
      "due-date": "2016-08-16T17:15:15Z",
      "requested-date": "2019-01-16T15:19:54Z"
    }
  ]
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Purchase order was deleted

Purchase order already has production orders created or other entities associated, cannot be removed.

Content-Type: application/json

[
  {
    "id": 987356123,
    "code": "PO123 - Week 47",
    "creation-date": "2022-04-19T08:30:01Z",
    "supplier": "Supplier X",
    "observations": "Ready next week",
    "products": [
      {
        "code": "V23076",
        "name": "Vessel",
        "quantity": 100,
        "due-date": "2019-08-16T17:15:15Z",
        "requested-date": "2019-01-16T15:19:54Z",
        "cost": 200.3
      },
      {
        "code": "V23077",
        "quantity": 99,
        "due-date": "2016-08-16T17:15:15Z",
        "requested-date": "2019-01-16T15:19:54Z"
      }
    ]
  },
  {
    "id": 987356124,
    "code": "PO123 - Week 48",
    "supplier": "Supplier X",
    "observations": "",
    "products": [
      {
        "code": "V23076",
        "name": "Vessel",
        "quantity": 70,
        "due-date": "2019-08-23T18:00:00Z",
        "requested-date": "2019-01-16T15:19:54Z",
        "cost": 140
      },
      {
        "code": "V23077",
        "quantity": 69,
        "due-date": "2016-08-23T18:00:00Z",
        "requested-date": "2019-01-16T15:19:54Z"
      }
    ]
  }
]

If there's a problem with the request, the problem found will be reported on the Response Body

Production Order  ¶

A single Production Order object. The Production Order resource is one of the most important resources of the Fusion Operations API. It represents the management order to produce a predetermined quantity of products during a defined period by defined workers.

The Production Order resource has the following attributes:

• id (supplied)

• code (string, required) - production order code

• start-date (date,required, format YYYY-MM-DDTHH:MM:SSZ) - date when this production order is scheduled to start

• due-date (date,required, format YYYY-MM-DDTHH:MM:SSZ) - date when this production order is due

• products (array, required, not empty) - products and quantities ordered

  • product (string, required, unique) - product code
  • quantity-ordered (integer, required, >0) - quantity ordered
  • observations (optional) - note about this product
  • quantity-produced (integer, supplied, >0) - quantity produced

• description (optional) - description for this production order

• shipping (optional) - shipping code for this order

• workers-assigned (array,optional) -

  • number - worker number

• machines (array,optional)

  • code - machine code

• serial-number (optional)

• description (optional)

• notes (optional)

• status (supplied) - scheduled (before start_date and completeness = 0), onschedule (before end_date and completeness < 100%), delayed (after end_date completeness < 100%), completed (completeness >= 100%)

• running-status (supplied) - notstarted (no productions), started (with productions), closed (manually closed or closed by completion), archived (manually archived)

The state id is assigned by the Fusion Operations API at the moment of creation.

Content-Type: application/json

{
  "products": [
    {
      "product": "V23076",
      "quantity-ordered": 3500,
      "observations": "",
      "quantity-produced": 700
    }
  ],
  "code": "V23076 - Semana 33/34",
  "shipping": {
    "code": "shipping 45"
  },
  "serial-number": "",
  "description": "",
  "start-date": "2016-04-20T09:15:15Z",
  "due-date": "2016-05-16T17:15:15Z",
  "workers-assigned": [
    {
      "number": 120
    },
    {
      "number": 11
    },
    {
      "number": 10
    },
    {
      "number": 1
    }
  ],
  "ended": false,
  "machines": [
    {
      "code": "A32"
    },
    {
      "code": "F1"
    }
  ],
  "pieces-by-box": 20,
  "status": "onschedule",
  "running-status": "started",
  "notes": "",
  "location": {
    "id": "location id",
    "code": "location code",
    "name": "location name"
  },
  "id": 3990
}

Content-Type: application/json

{
  "products": [
    {
      "product": "exampleProduct",
      "quantity-ordered": 3,
      "observations": "",
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ]
    }
  ],
  "code": "exampleCode",
  "shipping": {
    "code": "shipping 45"
  },
  "serial-number": "",
  "description": "",
  "start-date": "2016-04-20T09:15:15Z",
  "due-date": "2016-05-16T17:15:15Z",
  "parameters": [
    {
      "name": "Custom Field Name",
      "value": "123"
    },
    {
      "name": "Custom Field Name 2",
      "value": "456"
    }
  ],
  "workers-assigned": [
    {
      "number": 120
    },
    {
      "number": 1
    }
  ],
  "worker-groups": [
    {
      "name": "exampleWorkerGroups"
    }
  ],
  "machines": [
    {
      "code": "A32"
    },
    {
      "code": "F1"
    }
  ],
  "pieces-by-box": 25,
  "notes": "",
  "location": "location code"
}

{
  "products": [
    {
      "product": "exampleProduct",
      "quantity-ordered": 3,
      "observations": "",
      "quantity-produced": 700,
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ],
      "serial-numbers": "serial1,serial2,serial3"
    }
  ],
  "code": "exampleCode",
  "shipping": {
    "code": "shipping 45"
  },
  "serial-number": "",
  "description": "",
  "start-date": "2016-04-20T09:15:15Z",
  "due-date": "2016-05-16T17:15:15Z",
  "parameters": [
    {
      "name": "Custom Field Name",
      "value": "123"
    },
    {
      "name": "Custom Field Name 2",
      "value": "456"
    }
  ],
  "workers-assigned": [
    {
      "number": 120
    },
    {
      "number": 11
    },
    {
      "number": 10
    },
    {
      "number": 1
    }
  ],
  "machines": [
    {
      "code": "exampleMachine"
    },
    {
      "code": "F1"
    }
  ],
  "pieces-by-box": 25,
  "status": "onschedule",
  "running-status": "started",
  "notes": "",
  "location": {
    "id": "location id",
    "code": "location code",
    "name": "location name"
  },
  "id": 3990
}

Content-Type: application/json

Content-Type: application/json

{
  "products": [
    {
      "product": "productExample",
      "quantity-ordered": 4500,
      "observations": "",
      "parameters": [
        {
          "name": "Product Custom Field Name",
          "value": "123"
        },
        {
          "name": "Product Custom Field Name 2",
          "value": "456"
        }
      ]
    }
  ],
  "code": "exampleCode",
  "shipping": "shippingExample",
  "serial-number": "",
  "description": "",
  "start-date": "2016-07-20T09:15:15Z",
  "due-date": "2016-08-16T17:15:15Z",
  "parameters": [
    {
      "name": "Custom Field Name",
      "value": "123"
    },
    {
      "name": "Custom Field Name 2",
      "value": "456"
    }
  ],
  "workers-assigned": [
    {
      "number": 1
    },
    {
      "number": 3
    }
  ],
  "worker-groups": [
    {
      "name": "All"
    }
  ],
  "ended": false,
  "machines": [
    {
      "code": "exampleMachine"
    },
    {
      "code": "F1"
    }
  ],
  "pieces-by-box": 20,
  "notes": "",
  "active": true,
  "location": "location code"
}

{
    "products": [
      {
        "product": "productExample",
        "quantity-ordered": 4500,
        "observations": "",
        "parameters" : [
          {
            "name" : "Product Custom Field Name",
            "value" : "123"
          },
          {
            "name" : "Product Custom Field Name 2",
            "value" : "456"
          }
        ],
        "quantity-produced": 0
        }
    ],
    "code": "exampleCode",
    "shipping": "shippingExample",
    "serial-number": "",
    "description": "",
    "start-date": "2016-07-20T09:15:15Z",
    "due-date": "2016-08-16T17:15:15Z",
    "workers-assigned": [
      { "number": 1 },
      { "number": 2 }
      { "number": 3 }
      { "number": 4 }
    ],
    "ended": false,
    "machines": [
      {"code": "exampleMachine"},
      {"code": "F1"}
    ],
    "pieces-by-box": 20,
    "status": "scheduled",
    "running-status": "notstarted",
    "notes": "",
    "active": true,
    "location": {
      "id": "location id",
      "code": "location code",
      "name": "location name"
    },
    "id": 11110
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

[{
    "products": [
      {
        "product": "exampleProduct",
        "quantity-ordered": 4500,
        "observations": "",
        "quantity-produced": 0
      }
    ],
    "code": "exampleCode",
    "shipping": "Shipping 45",
    "serial-number": "",
    "description": "",
    "start-date": "2016-07-20T09:15:15Z",
    "due-date": "2016-08-16T17:15:15Z",
    "workers-assigned": [
      { "number": 10 },
      { "number": 1 }
    ],
    "ended": false,
    "machines": [
      {"code": "exampleMachine"},
      {"code": "F1"}
    ],
    "pieces-by-box": 20,
    "status": "scheduled",
    "running-status": "notstarted",
    "notes": "",
    "active": true,
    "location": {
      "id": "location id",
      "code": "location code",
      "name": "location name"
    }
    "id": 8763990
}]

Content-Type: application/json

{
  "short-message": "example",
  "message": "complete message "
}

Content-Type: application/json

{}

Production Order was already active

Production Order was closed or archived and cannot be activated

Product  ¶

A single Product object. The Product resource is one of the most important resources of the Fusion Operations API. It represents the products in a factory and contains the operations necessary to be produced. This method creates new Products and its Operations. Can also be used

The Product resource has the following attributes:

• code (string, required) - product code

• name (string, required) - product name

• section (string, optional)

• families (array, optional)

  • code (string, required) - family code

• color (string, optional) - color shortcut or hexadecimal or rgb

• observations (string, optional) - product observations

• operations (array, optional) - operations to produce the product

  • code (string, required) - operation code
  • name (string, required) - operation name
  • waste (array, optional)
    • code (string, required) - waste code
  • task-durations (array, optional, max:1)
    • validSince (date, required, format YYYY-MM-DDTHH:MM:SSZ) - date from when this duration is valid
    • validUntil (date, required, format YYYY-MM-DDTHH:MM:SSZ) - date to when this duration is valid
    • duration (time, optional, e.g. format “10H59m59s”) - the average time this operation takes to execute, in theory
    • duration-customer (time, optional, e.g. format “10H59m59s”) - the time set in budget
    • ratio-quantity (double, optional, default: 1.0) - the volume produced in each instance of this operation
  • times-per-product (integer, optional, default: 1) - the number of times this operation has to be performed to complete a product unit
  • checklists (array, optional)
    • code (string, required) - checklist code
  • machines (array, optional, must exist on the system) - machines that can be used to perform the operation
    • code (string, required) - the machine code, already created in the system
  • disabled (boolean, optional) - disable the operation
  • optional (boolean, optional) - set the operation as optional
  • recovery (boolean, optional) - set the operation as recovery
  • no-time (boolean, optional) - do not register production times
  • no-quantity (boolean, optional) - do not register production quantity
  • as-team (boolean, optional) - operation to be performed as team
  • multi-po (boolean, optional) - operation to be performed in multiple production orders
  • print-production-barcode (boolean, optional) - print production barcode
  • prepare-batch-order (boolean, optional) - prepare batch order

• custom-fields (array, optional)

  • code (string, required) - custom field code
  • value (string, required) - custom field value

• parameters (array, optional)

  • name (string, required) - parameter name
  • value (string, required) - parameter value

• serializable (boolean, optional) - product is serializable

Fields not present in the request will be set with the default values. When using this method for existing products/operations, not present fields will be considered deletions.

Content-Type: application/json

{
  "code": "P11",
  "name": "Product 11",
  "section": null,
  "families": null,
  "color": "#8b0000",
  "observations": "observations",
  "operations": [
    {
      "code": "op1",
      "name": "op1",
      "waste": null,
      "task-durations": [
        {
          "validSince": "01/01/2022 - 13:00",
          "validUntil": "01/01/2100 - 13:00",
          "duration": "00H01m00s",
          "duration-customer": "00H01m00s",
          "ratio-quantity": 1
        }
      ],
      "custom-fields": null,
      "machines": null,
      "disabled": false,
      "optional": false,
      "recovery": null,
      "no-time": false,
      "no-quantity": false,
      "as-team": false,
      "max-waste-threshold": null,
      "section": {
        "name": "specialsection"
      },
      "id": 100
    }
  ],
  "custom-fields": null,
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "label": {
    "code": "labelCode"
  },
  "serializable": true,
  "id": 24
}

If product with the provided code doesn't exist.

Content-Type: application/json

{
  "code": "P11",
  "name": "Product 11",
  "families": [
    {
      "code": "FG"
    }
  ],
  "color": "#8b0000",
  "observations": "observations",
  "operations": [
    {
      "code": "op1",
      "name": "op1",
      "waste": [
        {
          "code": "BROKEN"
        }
      ],
      "task-durations": [
        {
          "validSince": "01/01/2022 - 13:00",
          "validUntil": "01/01/2100 - 13:00",
          "duration": "00H01m00s",
          "duration-customer": "00H01m00s",
          "ratio-quantity": 1
        }
      ],
      "times-per-product": 2,
      "checklists": [
        {
          "code": "CheckIn"
        }
      ],
      "machines": [
        {
          "code": "OVEN02"
        }
      ],
      "disabled": false,
      "optional": false,
      "recovery": false,
      "no-time": false,
      "no-quantity": false,
      "as-team": false,
      "multi-po": false,
      "print-production-barcode": false,
      "prepare-batch-order": false,
      "section": {
        "name": "CUT"
      }
    }
  ],
  "custom-fields": null,
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    }
  ],
  "serializable": true
}

{
  "code": "P11",
  "name": "Product 11",
  "families": [
    {
      "code": "FG"
    }
  ],
  "color": "#8b0000",
  "observations": "observations",
  "operations": [
    {
      "code": "op1",
      "name": "op1",
      "waste": [
        {
          "code": "BROKEN"
        }
      ],
      "task-durations": [
        {
          "validSince": "01/01/2022 - 13:00",
          "validUntil": "01/01/2100 - 13:00",
          "duration": "00H01m00s",
          "duration-customer": "00H01m00s",
          "ratio-quantity": 1
        }
      ],
      "times-per-product": 2,
      "checklists": [
        {
          "code": "CheckIn"
        }
      ],
      "machines": [
        {
          "code": "OVEN02"
        }
      ],
      "disabled": false,
      "optional": false,
      "recovery": false,
      "no-time": false,
      "no-quantity": false,
      "as-team": false,
      "multi-po": false,
      "print-production-barcode": false,
      "prepare-batch-order": false,
      "section": {
        "name": "CUT"
      }
    }
  ],
  "custom-fields": null,
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    }
  ],
  "serializable": true,
  "id": 24
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "code": "P11",
  "name": "Product 11",
  "operations": [
    {
      "code": "op1",
      "name": "op1",
      "section": {
        "name": "specialsection"
      }
    }
  ],
  "color": "color shortcut or hexadecimal or rgb",
  "observations": "observations text",
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "label": {
    "code": "Label 1"
  }
}

{
  "code": "P11",
  "name": "Product 11",
  "section": null,
  "families": null,
  "color": "#8b0000",
  "observations": "observations",
  "operations": [
    {
      "code": "op1",
      "name": "op1",
      "waste": null,
      "task-durations": [
        {
          "validSince": "01/01/2022 - 13:00",
          "validUntil": "01/01/2100 - 13:00",
          "duration": "00H01m00s",
          "duration-customer": "00H01m00s",
          "ratio-quantity": 1
        }
      ],
      "custom-fields": null,
      "machines": null,
      "disabled": false,
      "optional": false,
      "recovery": null,
      "no-time": false,
      "no-quantity": false,
      "as-team": false,
      "max-waste-threshold": null,
      "section": {
        "name": "specialsection"
      },
      "id": 123
    }
  ],
  "label": {
    "code": "Label 1"
  },
  "custom-fields": null,
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "id": 20
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Content-Type: application/json

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "code": "P11",
  "name": "Product 11",
  "section": null,
  "families": null,
  "operations": [
    {
      "code": "op1",
      "name": "op1",
      "waste": null,
      "task-durations": [
        {
          "validSince": "01/01/2022 - 13:00",
          "validUntil": "01/01/2100 - 13:00",
          "duration": "00H01m00s",
          "duration-customer": "00H01m00s",
          "ratio-quantity": 1
        }
      ],
      "custom-fields": null,
      "parameters": [
        {
          "name": "parameter1",
          "value": "value1"
        },
        {
          "name": "parameter2",
          "value": "2022-12-19T00:00:00Z"
        },
        {
          "name": "parameter3",
          "value": 1
        }
      ],
      "machines": null,
      "disabled": false,
      "optional": false,
      "recovery": null,
      "no-time": false,
      "no-quantity": false,
      "as-team": false,
      "max-waste-threshold": null,
      "section": {
        "name": "specialsection"
      },
      "id": 123
    }
  ],
  "label": {
    "code": "Label 1"
  },
  "custom-fields": null,
  "id": 20
}

If there's a problem with the request, the problem found will be reported on the Response Body

Product BoM  ¶

The Product’s Bill of Materials (BoM) resource stipulates the materials used to manufacture a specific product. The BoM has the following attributes:

• product-code - main product

• bom (array,required)

  • product-code (string, required) - component/consumption product code
  • quantity (double, required) - quantity
  • operation-code (string, optional) - operation code where the material defined in the product-code is consumed. If empty, the consumption will occur on the first operation of the manufacturing process for this product.

Content-Type: application/json

{
  "product-code": "bicycle",
  "bom": [
    {
      "product-code": "wheel",
      "quantity": 2,
      "operation-code": "assemble"
    },
    {
      "product-code": "seat",
      "quantity": 1,
      "operation-code": "assemble"
    }
  ]
}

{
  "product-code": "bicycle",
  "bom": [
    {
      "product-code": "wheel",
      "quantity": 2,
      "operation-code": "assemble"
    },
    {
      "product-code": "seat",
      "quantity": 1,
      "operation-code": "assemble"
    }
  ]
}

Main product not found

If there's a problem with the request, the problem found will be reported on the Response Body

Product Stock  ¶

The Stock resource stipulates the stock available for a specific product.

• product-code (string, required)

• stock (double, required)

• date (date, optional) - date of the stock count

Content-Type: application/json

{
  "product-code": "bicycle",
  "stock": 200.5,
  "date": "2016-08-16T17:15:15Z"
}

Request successfull

Product not found

If there's a problem with the request, the problem found will be reported on the Response Body

Product Family  ¶

The ProductFamily object represents the family or families a product belongs to.

The ProductFamily resource has the following attributes:

• code (string, required) - product family code

• name (string, required) - product family name

Content-Type: application/json

{
  "product-families": [
    {
      "code": "FAM 1",
      "name": "Family 1"
    },
    {
      "code": "FAM 2",
      "name": "Family 2"
    }
  ]
}

[
  {
    "code": "FAM 1",
    "name": "Family 1"
  },
  {
    "code": "FAM 2",
    "name": "Family 2"
  }
]

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  under development
}

{
 under development
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Content-Type: application/json

Product Family was deleted

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

[
  {
    "code": "FAM 1",
    "name": "Family 1"
  },
  {
    "code": "FAM 2",
    "name": "Family 2"
  }
]

If there's a problem with the request, the problem found will be reported on the Response Body

Counter  ¶

Status: available

Content-Type: application/json

{
  "count": 500,
  "waste": [
    {
      "code": "Waste1",
      "quantity": 20
    }
  ],
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ]
}

Returns the new value for the machine's counter.

If there's a problem with the request, the problem found will be reported on the Response Body

Downtime  ¶

Status: available

Content-Type: application/json

{
  "type": "Maintenance",
  "running": 0
}

Production  ¶

A single Production object. The Production resource is the central resource of the Fusion Operations API. It represents the labour from one worker in a position during a period of time.

The Production resource has the following attributes:

• id

• start-time (date,required, format YYYY-MM-DDTHH:MM:SSZ) - production start time

• end-time (date,required, format YYYY-MM-DDTHH:MM:SSZ) - production end time

• work-time (duration,given, format 00H00m00s) - production work time (within schedule time/punch clocks and excluding downtimes)

• production-order(optional) - production order for which this production was done

  • code (string, required) - production order code
  • id (string, required) - production order code

• operation (required) - task that was executed in this production

  • code (string, required, unique) - task code
  • product (required) - the material good that the worker is working in this position

• quantity (integer, required, >0) - quantity produced in this production

• worker (required) - a person that performs tasks

  • number (long, required, unique) - worker number

• produced-waste (array, optional) - defective material output in an operation

  • quantity (numeric, required) - waste code
  • waste - type of defective material
    • code (string, required, unique) - waste code
    • description (string, required) - waste description
    • flaw (string, required) - waste type
    • quantity (integer, required) - amount of waste produced

The state id is assigned by the Fusion Operations API at the moment of creation.

Content-Type: application/json

{
  "shipping": {
    "code": "shippingExampleCode00"
  },
  "production-order": {
    "code": "productionExampleCode00"
  },
  "operation": {
    "product-code": "productExampleCode",
    "code": "exampleOperation00"
  },
  "worker": {
    "number": "1000"
  },
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "quantity": 100,
  "start-time": "2016-07-20T09:15:15Z",
  "end-time": "2016-07-20T09:15:16Z",
  "lot-number": "lotExample",
  "finished": false,
  "location": "location code"
}

{
  "id": 4629378,
  "production-order": {
    "code": "productionExampleCode00",
    "id": 365315
  },
  "shipping": {
    "code": "shippingExampleCode00",
    "id": 41741
  },
  "operation": {
    "code": "exampleOperation00",
    "product-code": "productExampleCode00",
    "id": 790486
  },
  "worker": {
    "number": 1000,
    "name": "Worker Example",
    "id": 15890
  },
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "quantity": 100,
  "lot-number": "lotExample",
  "start-time": "2016-07-20T09:15:15.000Z",
  "end-time": "2016-07-20T09:15:16.000Z",
  "finished": false,
  "location": {
    "id": "location id",
    "code": "location code",
    "name": "location name"
  }
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

{
  "shipping": {
    "code": "shippingexamplecode00"
  },
  "production-order": {
    "code": "productionorderexample00"
  },
  "operation": {
    "product-code": "otherProductCode",
    "code": "OtherOperationCode"
  },
  "worker": {
    "number": "1000"
  },
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "quantity": 100,
  "start-time": "2016-07-20T09:15:15Z",
  "end-time": "2016-07-20T09:15:16Z",
  "lot-number": "other lot",
  "finished": false,
  "location": "location code"
}

{
  "id": 4629374,
  "production-order": {
    "code": "productionorderexample00",
    "id": 365315
  },
  "shipping": {
    "code": "shippingexamplecode00",
    "id": 41741
  },
  "operation": {
    "code": "OtherOperationCode",
    "product-code": "otherProductCode",
    "id": 790486
  },
  "worker": {
    "number": 1000,
    "name": "Worker Name",
    "id": 15890
  },
  "parameters": [
    {
      "name": "parameter1",
      "value": "value1"
    },
    {
      "name": "parameter2",
      "value": "2022-12-19T00:00:00Z"
    },
    {
      "name": "parameter3",
      "value": 1
    }
  ],
  "quantity": 100,
  "lot-number": "other lot",
  "start-time": "2016-07-20T09:15:15.000Z",
  "end-time": "2016-07-20T09:15:16.000Z",
  "finished": false,
  "location": {
    "id": "location id",
    "code": "location code",
    "name": "location name"
  }
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

Content-Type: application/json

The deleted production will be returned

{
  "id": 4629376,
  "production-order": {
    "code": "productionorderexample00",
    "id": 365315
  },
  "shipping": {
    "code": "shippingexamplecode00",
    "id": 41741
  },
  "operation": {
    "code": "operationexample0001",
    "product-code": "productcodeexample001",
    "id": 790486
  },
  "worker": {
    "number": 1000,
    "name": "worker example",
    "id": 15890
  },
  "parameters": [{
    "name": "parameter1",
    "value": "value1"
  }, {
    "name": "parameter2",
    "value": "2022-12-19T00:00:00Z"
  }, {
    "name": "parameter3",
    "value": 1.0
  }],
  "quantity": 100.0,
  "lot-number": "lotX",
  "start-time": "2016-07-20T09:15:15.000Z",
  "end-time": "2016-07-20T09:15:16.000Z",
  "finished": false,
  "location": {
    "id": "location id",
    "code": "location code",
    "name": "location name"
  }
}

If there's a problem with the request, the problem found will be reported on the Response Body

Content-Type: application/json

[
  {
    "production-order": {
      "code": "PO1",
      "id": 36530
    },
    "operation": {
      "code": "2",
      "product": "Product 1"
    },
    "worker": {
      "number": 2
    },
    "machine": {
      "code": "Machine Code"
    },
    "produced-waste": [
      {
        "quantity": 21,
        "waste": {
          "code": "Waste code",
          "description": "Description of this type of waste",
          "flaw": "Flaw",
          "recoverable": true,
          "billable": false,
          "id": 333
        }
      }
    ],
    "parameters": [
      {
        "parameter1": "value1"
      },
      {
        "parameter2": 2
      }
    ],
    "quantity": 0,
    "checked-out": false,
    "work-time": "00H00m00s",
    "start-time": "2016-09-20T17:55:32.000+01:00",
    "end-time": "2016-09-20T18:45:00.000+01:00",
    "location": {
      "id": "location id",
      "code": "location code",
      "name": "location name"
    },
    "id": 575354
  }
]

DownTimes  ¶

Content-Type: application/json

[
  {
    "id": 20146,
    "start-time": "2017-12-21T10:30:21.000Z",
    "end-time": "2017-12-21T10:32:21.000Z",
    "started-by": {
      "number": 2
    },
    "closed-by": {
      "number": 2
    },
    "workers": [],
    "machines": [
      {
        "code": "M2",
        "name": "Machine 2"
      }
    ],
    "product": "ProdX",
    "production-order": "OP XPTO",
    "checked-out": true,
    "downtime-type": "Malfunction",
    "time-spent": "00H02m00s"
  }
]

PunchClock  ¶

Webhooks are available for punch clock events from the integrations menu in the app. In order to use this feature, please add the endpoint URL callback with the notification events you want to listen to. We strive to send webhook notifications as quickly as events occur in our system. Currently, we don’t support any retries and the webhook request timeout is 30 seconds.

Content-Type: application/json

[
{
    "id": 372179,
    "date": "2018-09-21T09:24:06.000+01:00",
    "worker": {
        "number": 2
    },
    "type": 1
},
{
    "id": 372180,
    "date": "2018-09-21T16:34:12.000+01:00",
    "worker": {
        "number": 2
    },
    "type": 0
}
]
"type": 0 ('out') or 1 ('in')

inventory Movement  ¶

A single Inventory Movement object. The Inventory Movement resource is one of the most important resources of the Fusion Operations API.

The Inventory Movement resource has the following attributes:

• id (supplied)

• product (string, required) - product code

• date-time (date, optional, format YYYY-MM-DDTHH:MM:SSZ) - date when inventory movement is created

• quantity (double, required) - inventory movement quantity

• type (string, required) - inventory movement type: in,out,consumption,production

• lot (string, optional) - inventory movement lot to use

• total-cost (bigdecimal, optional) - inventory movement total cost for the quantity

• warehouse-location (string, optional) - warehouse location code. When empty, Fusion Operations defaults to the Production warehouse.

• warehouse (string, optional) - warehouse code. When empty, Fusion Operations defaults to the Production warehouse location.

• location (string, optional) - location, if multisite

• comment (string, optional) - inventory movement comment

Content-Type: application/json