Orders

This resource is meant for ordering or purchasing ARRI Webgate products. It generates a unique hexadecimal-string with length 16 (order_hash) for every order. This hash can be used to check the status of your order and call a special registration page for customers.

We have the following wording (German):

  • Client (Kunde)
  • Project (Projekt)
  • User (Mitglied)

A project always belongs to a client. A project can have several users.

Attributes shown with action GET
admin_user_access_token string If there is an admin user which has the right to create projects, supply their OAuth access_token. This would usually be the client_admin.
client_id integer Must be provided, if user or project shall be added to it. The admin_user_access_token must be of the respective client_admin. In case of "Yamdu FREE" It is always the first user of the first order.
client_name string Only mandatory, if you want a new client to be created. Provide no client_id then.
order_hash string This is the ID of your order. Use it as ID for GET requests and for the special registration.
packing_errors text Explanations, why packing has failed. "Packing" means the order being processed, like creating the project, etc.
product string ARRI Webgate product you wish to buy. E.g. "Yamdu FREE".
project_id integer If you want to add to a project, the id must be provided
project_name string Only mandatory, if you want a new project to be created. Provide no project_id then.
redirection_uri string If given, status changes will be sent to this uri. (Not implemented, yet.)
state string pending: Order received, waiting for processing.
packed: Product successfully delivered.
packing: Order being processed. Do not touch anything!
has_packing_errors: Something went wrong. Please check packing_errors field.
need_human: Order cannot be packed automatically. Please come back and check, if order is in packed state, yet.
user_email string
user_first_name string
user_last_name string
user_login string
Attributes which can be POSTed
admin_user_access_token string If there is an admin user which has the right to create projects, supply their OAuth access_token. This would usually be the client_admin.
client_id integer Must be provided, if user or project shall be added to it. The admin_user_access_token must be of the respective client_admin. In case of "Yamdu FREE" It is always the first user of the first order.
client_name string Only mandatory, if you want a new client to be created. Provide no client_id then.
product string ARRI Webgate product you wish to buy. E.g. "Yamdu FREE".
project_id integer If you want to add to a project, the id must be provided
project_name string Only mandatory, if you want a new project to be created. Provide no project_id then.
redirection_uri string If given, status changes will be sent to this uri. (Not implemented, yet.)
user_email string
user_first_name string
user_last_name string
user_login string
Actions
Show GET /orders/{order_hash} -
Create POST /orders necessary data: {"order":{"product":"Yamdu FREE"}}

Ordering an ARRI Webgate product.

To order a ARRI Webgate product you have to set the product in your POST request. Accepted products are Starter, Commercial, Studio, Dailies, Yamdu FREE, s, m, l, xl

Example

Request:

POST /api/orders HTTP/1.1
Authorization: Bearer example-token
Content-Type: application/json

{"order":{"product":"s", "client_name":"Constantin Film", "project_name": "OSD Yamdu Free", "user_email": "nicecustomer@gmx.com", "user_login":"custy1"}}

Response:

HTTP/1.1 201 Created

{"status":201,"status_message":"Created","info":"","data":{"order":{"admin_user_access_token":null,"client_name":"Constantin Film",
"order_hash":"74853f7b0b78c3c74676e686dc103f5e","product":"s","project_name":"OSD Yamdu Free","redirection_uri":null,"status":null,
"user_email":"nicecustomer@gmx.com","user_first_name":null,"user_last_name":null,"user_login":"custy1"}}}