cURL

curl --request POST \
  --url https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "good_quantity": "<string>"
}
'

import requests

url = "https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete"

payload = { "good_quantity": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'good_quantity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete"

	payload := strings.NewReader("{\n  \"good_quantity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "<string>",
    "number": "<string>",
    "status": "<string>",
    "item_id": "<string>",
    "item_sku": "<string>",
    "item_name": "<string>",
    "quantity": "<string>",
    "unit": "<string>",
    "location_id": "<string>",
    "location_code": "<string>",
    "location_name": "<string>",
    "due_on": "<string>",
    "note": "<string>",
    "revision_label": "<string>",
    "parts_list_fixed": true,
    "blocked": "<string>",
    "lines": [
      {
        "position": "<string>",
        "component_id": "<string>",
        "component_sku": "<string>",
        "component_name": "<string>",
        "required": "<string>",
        "unit": "<string>",
        "available": "<string>",
        "short": "<string>",
        "explanation": "<string>",
        "open_orders": [
          {
            "number": "<string>",
            "quantity": "<string>",
            "expected_on": "<string>"
          }
        ],
        "alternates": [
          {
            "rank": 123,
            "component_id": "<string>",
            "component_sku": "<string>",
            "component_name": "<string>",
            "quantity": "<string>",
            "unit": "<string>",
            "available": "<string>"
          }
        ],
        "id": "<string>",
        "held": "<string>",
        "issued": "<string>",
        "variance": "<string>",
        "variance_reason": "<string>"
      }
    ],
    "released_at": "<string>",
    "cancelled_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "can_complete": true,
    "can_issue": true,
    "issues": [
      {
        "step": 123,
        "position": "<string>",
        "component_id": "<string>",
        "component_sku": "<string>",
        "alternate_rank": 123,
        "quantity": "<string>",
        "lots": [
          "<string>"
        ],
        "serials": [
          "<string>"
        ],
        "cost": "<string>",
        "issued_at": "<string>"
      }
    ],
    "output": {
      "status": "<string>",
      "lot": "<string>",
      "serials": [
        "<string>"
      ],
      "cost": "<string>",
      "unit_cost": "<string>",
      "issued_as_recorded": true,
      "completed_at": "<string>",
      "reversed_at": "<string>"
    },
    "currency": "<string>",
    "started_at": "<string>",
    "can_trace": true,
    "operations": [
      {
        "id": "<string>",
        "sequence": 123,
        "name": "<string>",
        "work_center_id": "<string>",
        "work_center_code": "<string>",
        "work_center_name": "<string>",
        "instructions": "<string>",
        "setup_minutes": "<string>",
        "run_minutes": "<string>",
        "status": "<string>",
        "started_at": "<string>",
        "started_by_you": true,
        "good_quantity": "<string>",
        "scrap_quantity": "<string>",
        "scrap_reason": "<string>",
        "completed_at": "<string>",
        "worked_minutes": "<string>",
        "can_take": "<string>",
        "blocked": "<string>",
        "time_records": [
          {
            "id": "<string>",
            "worked_by": 123,
            "you": true,
            "work_center_code": "<string>",
            "started_at": "<string>",
            "ended_at": "<string>",
            "minutes": "<string>",
            "corrects_id": "<string>",
            "created_at": "<string>"
          }
        ],
        "subcontract": {
          "supplier_id": "<string>",
          "supplier_name": "<string>",
          "service_item_id": "<string>",
          "service_sku": "<string>",
          "service_name": "<string>",
          "unit_price": "<string>",
          "purchase_order_id": "<string>",
          "purchase_order_number": "<string>",
          "sent": true,
          "returned": true,
          "cost": "<string>",
          "send_blocked": "<string>",
          "order_status": "<string>",
          "notice": "<string>",
          "can_bring_back": true,
          "can_reorder": true
        },
        "checks": [
          "<unknown>"
        ]
      }
    ],
    "problems": [
      {
        "id": "<string>",
        "operation_id": "<string>",
        "operation": "<string>",
        "reason": "<string>",
        "note": "<string>",
        "has_photo": true,
        "status": "<string>",
        "reported_by_you": true,
        "reported_at": "<string>",
        "close_note": "<string>",
        "closed_at": "<string>"
      }
    ],
    "can_run_operations": true,
    "can_manage": true,
    "priority": "<string>",
    "planned_start_on": "<string>",
    "planned_finish_on": "<string>",
    "late": true,
    "costs": {
      "estimate": {
        "parts": "<string>",
        "labor": "<string>",
        "overhead": "<string>",
        "total": "<string>",
        "subcontract": "<string>"
      },
      "actual": {
        "parts": "<string>",
        "labor": "<string>",
        "overhead": "<string>",
        "total": "<string>",
        "subcontract": "<string>"
      },
      "variance": {
        "parts": "<string>",
        "labor": "<string>",
        "overhead": "<string>",
        "total": "<string>",
        "subcontract": "<string>"
      },
      "final": true,
      "standard_unit_cost": "<string>",
      "standard_variance": "<string>"
    },
    "can_print_labels": true
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

Builds

Finish an operation of a build

Records how many came out good and how many were scrapped; scrap needs a reason. The first operation takes at most the build’s quantity and each later one at most what the one before it passed on good. A running span is kept as a time record. Unless the organization allows overlap, the operations before it must be finished. Answers with the build. Needs the manufacturing.operations.run permission and a token with manufacturing:write.

POST

manufacturing

builds

{build}

operations

{operation}

complete

cURL

curl --request POST \
  --url https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "good_quantity": "<string>"
}
'

import requests

url = "https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete"

payload = { "good_quantity": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'good_quantity' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.stockshift.io/api/v1/manufacturing/builds/{build}/operations/{operation}/complete"

	payload := strings.NewReader("{\n  \"good_quantity\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "id": "<string>",
    "number": "<string>",
    "status": "<string>",
    "item_id": "<string>",
    "item_sku": "<string>",
    "item_name": "<string>",
    "quantity": "<string>",
    "unit": "<string>",
    "location_id": "<string>",
    "location_code": "<string>",
    "location_name": "<string>",
    "due_on": "<string>",
    "note": "<string>",
    "revision_label": "<string>",
    "parts_list_fixed": true,
    "blocked": "<string>",
    "lines": [
      {
        "position": "<string>",
        "component_id": "<string>",
        "component_sku": "<string>",
        "component_name": "<string>",
        "required": "<string>",
        "unit": "<string>",
        "available": "<string>",
        "short": "<string>",
        "explanation": "<string>",
        "open_orders": [
          {
            "number": "<string>",
            "quantity": "<string>",
            "expected_on": "<string>"
          }
        ],
        "alternates": [
          {
            "rank": 123,
            "component_id": "<string>",
            "component_sku": "<string>",
            "component_name": "<string>",
            "quantity": "<string>",
            "unit": "<string>",
            "available": "<string>"
          }
        ],
        "id": "<string>",
        "held": "<string>",
        "issued": "<string>",
        "variance": "<string>",
        "variance_reason": "<string>"
      }
    ],
    "released_at": "<string>",
    "cancelled_at": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "can_complete": true,
    "can_issue": true,
    "issues": [
      {
        "step": 123,
        "position": "<string>",
        "component_id": "<string>",
        "component_sku": "<string>",
        "alternate_rank": 123,
        "quantity": "<string>",
        "lots": [
          "<string>"
        ],
        "serials": [
          "<string>"
        ],
        "cost": "<string>",
        "issued_at": "<string>"
      }
    ],
    "output": {
      "status": "<string>",
      "lot": "<string>",
      "serials": [
        "<string>"
      ],
      "cost": "<string>",
      "unit_cost": "<string>",
      "issued_as_recorded": true,
      "completed_at": "<string>",
      "reversed_at": "<string>"
    },
    "currency": "<string>",
    "started_at": "<string>",
    "can_trace": true,
    "operations": [
      {
        "id": "<string>",
        "sequence": 123,
        "name": "<string>",
        "work_center_id": "<string>",
        "work_center_code": "<string>",
        "work_center_name": "<string>",
        "instructions": "<string>",
        "setup_minutes": "<string>",
        "run_minutes": "<string>",
        "status": "<string>",
        "started_at": "<string>",
        "started_by_you": true,
        "good_quantity": "<string>",
        "scrap_quantity": "<string>",
        "scrap_reason": "<string>",
        "completed_at": "<string>",
        "worked_minutes": "<string>",
        "can_take": "<string>",
        "blocked": "<string>",
        "time_records": [
          {
            "id": "<string>",
            "worked_by": 123,
            "you": true,
            "work_center_code": "<string>",
            "started_at": "<string>",
            "ended_at": "<string>",
            "minutes": "<string>",
            "corrects_id": "<string>",
            "created_at": "<string>"
          }
        ],
        "subcontract": {
          "supplier_id": "<string>",
          "supplier_name": "<string>",
          "service_item_id": "<string>",
          "service_sku": "<string>",
          "service_name": "<string>",
          "unit_price": "<string>",
          "purchase_order_id": "<string>",
          "purchase_order_number": "<string>",
          "sent": true,
          "returned": true,
          "cost": "<string>",
          "send_blocked": "<string>",
          "order_status": "<string>",
          "notice": "<string>",
          "can_bring_back": true,
          "can_reorder": true
        },
        "checks": [
          "<unknown>"
        ]
      }
    ],
    "problems": [
      {
        "id": "<string>",
        "operation_id": "<string>",
        "operation": "<string>",
        "reason": "<string>",
        "note": "<string>",
        "has_photo": true,
        "status": "<string>",
        "reported_by_you": true,
        "reported_at": "<string>",
        "close_note": "<string>",
        "closed_at": "<string>"
      }
    ],
    "can_run_operations": true,
    "can_manage": true,
    "priority": "<string>",
    "planned_start_on": "<string>",
    "planned_finish_on": "<string>",
    "late": true,
    "costs": {
      "estimate": {
        "parts": "<string>",
        "labor": "<string>",
        "overhead": "<string>",
        "total": "<string>",
        "subcontract": "<string>"
      },
      "actual": {
        "parts": "<string>",
        "labor": "<string>",
        "overhead": "<string>",
        "total": "<string>",
        "subcontract": "<string>"
      },
      "variance": {
        "parts": "<string>",
        "labor": "<string>",
        "overhead": "<string>",
        "total": "<string>",
        "subcontract": "<string>"
      },
      "final": true,
      "standard_unit_cost": "<string>",
      "standard_variance": "<string>"
    },
    "can_print_labels": true
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "errors": {},
  "feature": "<string>",
  "reason": "<string>",
  "attempts_left": 123,
  "rule_ids": [
    "<string>"
  ],
  "witness": "<string>",
  "blind_recount": true,
  "flags": [
    {
      "flag": "<string>",
      "facts": {},
      "choices": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

build

string

required

operation

string

required

Body

application/json

How an operation of a build finished: how many came out good, how many were scrapped and, when any were, why.

good_quantity

string

required

How many came out good, in the item's base unit: an exact decimal of zero or more. The next operation takes at most this many.

Pattern: ^\d{1,20}(\.\d{1,20})?$

scrap_quantity

string | null

How many were scrapped: an exact decimal of zero or more, 0 when left out. Good and scrapped together are at most what the operation could take.

Pattern: ^\d{1,20}(\.\d{1,20})?$

scrap_reason

string | null

Why they were scrapped, needed when any were.

Maximum string length: 1000

checks

object[] | null

The checks recorded as it finished. A failed check is kept and does not stop it.

Maximum array length: 50

Show child attributes

Response

BuildResource

data

BuildResource · object

required

Show child attributes

Overview

Inventory

Catalog

Purchasing

Sales

Manufacturing

Engineering

Quality

Planning

Automation

Insights

Integrations

Labels

Documents

Devices

Sync

Access

Organization

Billing

Developer

Webhook events

Finish an operation of a build

Authorizations

Path Parameters

Body

Response