メインコンテンツにスキップ

API ドキュメント

David Andrade avatar
対応者：David Andrade
2週間以上前に更新

API ベース URI エンドポイント

すべての API 呼び出しのエンドポイントは、https://app.prodsmart.com/ です。

認証

Prodsmart API は簡単なトークン認証を使用します。最初に、新しいトークンを作成します(または既存のトークンを取得します)。トークンを取得したら、それを使用してトークン範囲内の他のリソースにアクセスできます。

認証トークンは 2 時間有効で、その後 API 資格情報を使って新しい認証トークンを要求する必要があります。

[用紙の種類]

メッセージ本文を含むリクエストは、プレーンな JSON を使用してリソースの状態を設定または更新します。

エラー状態

一般的な HTTP 応答ステータス コードが使用されます。

無効な JSON

「無効なJSON」という応答を受け取った場合は、JSONLint で使用している JSON ペイロードを検証してください。

レート制限

API リクエストは、1 企業につき 1 分あたり 120 リクエストに制限されています。制限を超えると、それ以降のリクエストは HTTP ステータス コード 429「Too Many Requests」で応答します。

さらに、ヘッダーには、リクエストを再試行するまでに待機する必要がある秒数がヘッダーに表示されます。

Retry-After: <delay-seconds>

レート制限に対処するためのベスト プラクティス:

  • リクエストを均等に分散させることで、応答が遅くなる可能性がある使用量の急増を回避します。

  • Retry-After 情報を使って、いつリクエストが再試行されるかを知るロジックを開発します。

  • すべての統合が制限にカウントされるため、不必要な統合が並行して実行されていないことを確認してください。

日付形式

API の日付フィールドの形式は、ISO 8601 の表現に従います。

  • YYYY-MM-DDThh:mm:ssZ

この形式では、文字 T は必須の区切り記号として機能し、Z は必要があればタイムゾーン指定子となります。Z が使用されない場合、日付に適用されるタイムゾーンは、Prodsmart 社で設定されているタイムゾーンと同じになります。Z はゼロ タイムゾーンを表し、0 だけオフセットされています。

使用例

  • 使用されている時間が UTC より 1 時間進んでいる場合、ゾーン指定は「+01:00」、「+0100」、または単に「+01」である必要があります。

  • 会社のタイムゾーンが -05:00 に設定されており、送信された日付の形式が 2020-07-20T09:15:15Z である場合、日付は Prodsmart で 07/20/2020 - 04:15:15 と表示されます

  • 送信された形式が 2020-07-20T09:15:15 である場合、日付は Prodsmart で 07/20/2020 - 09:15:15(-05:00 タイムゾーンを持つ)と表示されます。これは、ユーザのタイムゾーンが -04:00 に設定されている場合、その日付は 07/20/2020 - 10:15:15 と表示されることを意味します

一般的な ERP 統合

ERP 統合の一般的なシナリオは、主に生産注文、在庫、製品カタログの同期です。

生産注文

ERP 側で生産注文が作成されると、ERP は生産注文作成サービスを使って 生産注文データを JSON 形式でProdsmart の API に送信する必要があります。Prodsmart で生産注文を作成または更新する際に ERP 側を更新する必要がある場合は、2 つの可能性があります。ERP に外部から連絡できる場合は Prodsmart でWebhooks を設定できます。また、Prodsmart 側で生産注文を作成、更新、削除すると Webhooks が呼び出されます。ERP に外部から連絡ができない場合、ERP は変更を検出するために生産注文リスト サービスをアクティブにポーリングする必要があります。

ストック

通常、ERP(または WMS)はストックのマスターであるため、ERP/WMS が製品の現在のストックを特定の数量に更新できるサービス(製品ストックの更新)を提供します。場合によっては、ERP/WMS は、生産注文の変更を監視するか、Webhook または現在の在庫のウェブサービス(要求に応じて)を使用して、生産在庫の変更を通知されることがあります。

製品

それほど頻繁ではありませんが、製品カタログも同期されます。この場合、ERP は常にマスターであり、製品作成サービスを使って製品や作業を作成することができます。

Webhooks

Webhooks は、アプリの統合メニューから生産注文イベントに使用できます。この機能を使用するには、リッスンしたい通知イベントを含むエンドポイント URL コールバックを追加します。当社では、システムでイベントが発生するとすぐに Webhooks の通知を送信するよう努めています。多数の生産注文を同時に変更した場合、大量の通知が短期間に配信される場合があります。現在、再試行はサポートされていません。

ヘッダー

Webhooks ヘッダー
​

x-prodsmart-topic: "productionOrder/create"x-prodsmart-hmac-sha256: "c938fe31379c0d89b37468e1cae9e3aab2d56834"x-prodsmart-api-version: "1"x-prodsmart-webhook-uuid: "91cb972d-b476-4936-947c-4be471b9da5b"x-prodsmart-triggered-at: "2023-08-29T20:39:46.142Z"

注:

  • x-prodsmart-topic - Webhooks のトピックを特定します

  • x-prodsmart-hmac-sha256 - Webhooks の原点を確認するために使用されます

  • x-prodsmart-api-version - Webhooks の送信に使用する API のバージョン

  • x-prodsmart-webhook-uuid - 一意の Webhooks を識別します

  • x-prodsmart-triggered-at - Webhooks がトリガされた時刻

Webhook を確認する方法

  • 200 ステータス コードで応答する前に、Webhook の発信元が Prodsmart であることを確認することが重要です。この検証は、署名を計算することで達成されます。

  • すべての Webhook リクエストには、x-prodsmart-hmac-sha1という特定のヘッダーが付いており、これは base64 形式でエンコードされています。このヘッダーは、API シークレットと Webhook リクエストに含まれるデータの両方を使って生成されます。

  • Webhook の信頼性を確認するには、同じ API シークレットと指定されたデータを使用して、自分で署名を計算する必要があります。

  • 計算された署名を取得したら、それを受信した Webhook リクエストの x-prodsmart-hmac-sha1ヘッダーの値と比較します。

  • 計算された署名が x-prodsmart-hmac-sha1 ヘッダーの値と一致する場合、Webhook が本当に Prodsmart から送信されたものだと確認でき、200 ステータス コードを使って応答することができます。

生産注文

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{    "products": [        {            "product": "V23076",            "quantity-ordered": 3500,            "observations": "",            "quantity-produced": 700        }    ],    "code": "Test Production Order",    "shipping": {        "code": "shipping 45"    },    "serial-number": "",    "description": "",    "start-date": "2023-04-20T09:15:15Z",    "due-date": "2023-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": "",    "id": 1}

注: 生産注文が削除されると、実行ステータスも削除されます。

タイム レコーダー

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{    "id": 932015,    "date": "2022-05-19T14:35:30.000+01:00",    "notification": "punchClock_created",    "worker": {        "number": 0    },    "entry": 1}

  • 入力可能な値:

    • 1 - In

    • 0 - アウト

  • 通知可能な値:

    • punchClock_created

    • punchClock_updated

    • punchClock_deleted

出荷在庫移動

出荷在庫移動の作成/更新

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

[{    "product": {        "id": 222,        "code": "product-code",        "uom": "uom"    },    "lot": {        "code": "lot-code",        "expiration-date": "lot-expiration-date",        "supplier-lot": "supplier-lot-name"    },    "date": "2022-02-21T00:00:00Z",    "quantity": 10.0,    "stock-type": "out",    "comment": "comment",    "warehouse-location": {        "id": 333,        "code": "warehouse-location-code",        "warehouse": {            "id": 444,            "code": "warehouse-code"        }    },    "sales-order": {        "id": 555,        "code": "sales-order-code",        "client": {            "id": 777,            "code": "client-code"        },        "parameters": [{            "name": "parameterX",            "value": "valueX"        }]    },    "shipping": {        "id": 666,        "code": "shipping-code"    },    "worker": {        "id": 333,        "number": 0,        "name": "worker-name"    }}]

  • 通知可能な値:

    • shipping_inventory_movement_created

    • shipping_inventory_movement_updated

出荷在庫移動の削除

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{  "id": 111}

  • 通知可能な値:

    • shipping_inventory_movement_deleted

受入在庫移動

受入在庫移動の作成/更新

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

[{    "product": {        "id": 222,        "code": "product-code",        "uom": "uom"    },    "lot": {        "code": "lot-code",        "expiration-date": "lot-expiration-date",        "supplier-lot": "supplier-lot-name"    },    "date": "2022-02-21T00:00:00Z",    "quantity": 10.0,    "stock-type": "in",    "comment": "comment",    "warehouse-location": {        "id": 333,        "code": "warehouse-location-code",        "warehouse": {            "id": 444,            "code": "warehouse-code"        }    },    "purchase-order": {        "id": 555,        "code": "purchase-order-code",        "supplier": "supplier-code",        "parameters": [{            "name": "parameterX",            "value": "valueX"        }]    },    "receiving": {        "id": 666,        "code": "receiving-code"    },    "worker": {        "id": 333,        "number": 0,        "name": "worker-name"    }}]

  • 通知可能な値:

    • receiving_inventory_movement_created

    • receiving_inventory_movement_updated

受入在庫移動の削除

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{  "id": 111}

  • 通知可能な値:

    • receiving_inventory_movement_deleted

内部在庫移動

内部在庫移動の作成/更新

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

[{    "product": {        "id": 222,        "code": "product-code",        "uom": "uom"    },    "lot": {        "code": "lot-code",        "expiration-date": "lot-expiration-date",        "supplier-lot": "supplier-lot-name"    },    "date": "2022-02-21T00:00:00Z",    "quantity": 10.0,    "stock-type": "in",    "comment": "comment",    "warehouse-location": {        "id": 333,        "code": "warehouse-location-code",        "warehouse": {            "id": 444,            "code": "warehouse-code"        }    },    "worker": {        "id": 333,        "number": 0,        "name": "worker-name"    }}]

  • 通知可能な値:

    • internal_inventory_movement_created

    • internal_inventory_movement_updated

内部在庫移動の削除

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{  "id": 111}

  • 通知可能な値:

    • internal_inventory_movement_deleted

材料のステージング移動

材料のステージングの作成/更新

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

[{    "product": {        "id": 222,        "code": "product-code",        "uom": "uom"    },    "production-order": {        "id": 333,        "code": "production-order-code"    },    "lot": {        "code": "lot-code",        "expiration-date": "lot-expiration-date",        "supplier-lot": "supplier-lot-name"    },    "date": "2022-02-21T00:00:00Z",    "quantity": 10.0,    "warehouse-location": {        "id": 333,        "code": "warehouse-location-code",        "warehouse": {            "id": 444,            "code": "warehouse-code"        }    },    "worker": {        "id": 333,        "number": 0,        "name": "worker-name"    }}]

  • 通知可能な値:

    • material_staging_created

    • material_staging_updated

材料のステージングの削除

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{  "id": 111}

  • 通知可能な値:

    • material_staging_deleted

ロット

ロット作成/更新

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

[{    "code": "lot-code",    "creation-date": "2022-02-21T00:00:00Z",    "expiration-date": "2022-02-21T00:00:00Z",    "supplier-lot": "supplier-lot-name",    "product": {        "id": 222,        "code": "product-code",        "uom": "uom"    }}]

  • 通知可能な値:

    • lot_created

    • lot_updated

ロットの削除

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{  "id": 111}

  • 通知可能な値:

    • lot_deleted

ダウンタイム

ダウンタイムの作成/更新/削除

  • リクエスト(アプリケーション/json)

    • メソッド: POST

    • ボディ

{  "id": 1,  "start-time": "2000-01-01T00:00:00.000+01:00",  "end-time": "2099-12-31T23:59:59.999+01:00",  "started-by": {},  "closed-by": {    "number": 0  },  "workers": [    {      "number": 0    }  ],  "machines": [],  "product": "",  "production-order": "",  "checked-out": true,  "downtime-type": "downtime1 type",  "time-spent": "08:00:00",  "event-type": "downTime_created"}

  • 通知可能な値:

    • downTime_created

    • downTime_updated

    • downTime_deleted

フィード チャネルの変更

何らかの理由で Webhook を使用できない場合、現在、過去 24 時間以内に発生した変更、または当社が提供する Web サービス経由で変更をリクエストした以降に発生した変更を保存する変更スタックとして代替手段を提供しています。この機能を使用するには、統合メニュー(https://app.prodsmart.com/admin/integrations)でチャネルを作成する必要があります。組織ごとに最大 3 つのチャネルを作成できます。

変更チャネルには 6 つのタイプがあります。

  • ダウン タイム

  • 製品

  • 生産

  • 生産注文

  • タイム レコーダー

  • ストック

変更を取得

GET /api/changes/{channel}{?access_token}

このサービスを呼び出すと、作成、更新、削除された、または状態が変更されたために変更されたエンティティのリストを取得できます。エンティティの現在の状態を示す配列(最も古い変更から最新の変更の順)を受け取ります。サービスの呼び出しごとに最大 25 個が含まれます。サービスから取得したエンティティは、(新しい更新が行われるまで)スタックから削除されます。変更がない場合、サービスは空の配列("[]")を返します。

URL の例

GET /api/changes/channel?access_token=

URI パラメータ

チャネル

文字列(必須)

アクセスするチャネル

access_token

文字列(必須)

Prodsmart API アクセス トークン。

作業者

boolean (オプション)

生産注文のチャネル応答で作業者リストを表示

リクエスト

Content-Type: application/json

ダウンタイム

[    {        "id": 1435048,        "start-time": "2022-04-22T14:47:00.000+01:00",        "end-time": "2022-04-23T00:00:00.000+01:00",        "started-by": {},        "closed-by": {            "number": 1        },        "workers": [            {                "number": 1            }        ],        "machines": [],        "product": "",        "production-order": "",        "checked-out": true,        "downtime-type": "Maintenance",        "time-spent": "09:13:00",        "event-type": "downTime_deleted",    }]

注: イベントタイプ フィールドは、ダウン タイムが削除されたときのみ表示されます。

生産注文

[    {        "products": [            {                "product": "RN2",                "quantity-ordered": 30.0,                "observations": "",                "quantity-produced": 0.0            }        ],        "code": "Production Order 123",        "description": "",        "shipping": {},        "start-date": "2022-04-21T00:00:00.000+01:00",        "due-date": "2022-04-28T00:00:00.000+01:00",        "ended": false,        "machines": [],        "notes": "",        "is-active": true,        "running-status": "notstarted",        "status": "onschedule",        "material-staging-complete": false,        "id": 1379919    }]

注: 生産注文を削除すると、実行ステータス フィールドの値も削除されます。

製品

[    {        "code": "V23076",        "name": "V23076",        "observations": "",        "section": null,        "unit-cost": null,        "unit-price": null,        "families": [],        "operations": [],        "components": [],        "custom-fields": [],        "notification": null,        "serializable": null,        "shipping-package-types": [],        "external-stock": null,        "stock-max": null,        "min-quantity-reorder": null,        "quantity-multiple": null,        "scrap-allowance": null,        "shelf-life": null,        "parameters": []    }]

注: 製品が削除されると、通知フィールドの値は product_deleted になります。

生産記録 ¶

[    {        "production-order": {            "code": "P1 - Week 14",            "id": 3641        },        "operation": {            "code": "CUT3",            "product": "P1"        },        "worker": {            "number": 6        },        "machine": {            "code": "WJC"        },        "quantity": 0.0,        "checked-out": false,        "produced-waste": [],        "consumptions": [],        "total-time-factor": 1.0,        "rework": false,        "work-time": "00H00m00s",        "start-time": "2022-04-22T14:43:00.000+01:00",        "end-time": "2022-04-22T14:43:00.000+01:00",        "status": "deleted",        "show-check-in-checklist-and-c-f": false,        "id": 12952533    }]

注: ステータス フィールドは、生産記録が削除された場合にのみ表示されます。

タイム レコーダー

[  {      "id": 932015,      "date": "2022-05-19T14:35:30.000+01:00",      "notification": "punchClock_deleted",      "worker": {          "number": 0      },      "entry": 1  }]

注: 通知フィールドは、タイム レコーダーが削除された場合にのみ表示されます。

ストック

[    {        "product-code": "P1",        "stock": 2395.0,        "lot": [            {                "code": "Lot 0086",                "stock": 500.0            }        ]    }]

サプライヤー

Prodsmart API のサプライヤー リソースです。

サプライヤー

単一のサプライヤー オブジェクト

サプライヤー リソースには、次の属性があります。

  • id (指定値)

  • コード(文字列、必須、一意) - サプライヤー コード

  • 名前(文字列、必須) - サプライヤー名

  • 番号(文字列、オプション) - サプライヤー VAT 番号

  • 有効期限(日付、オプション、形式 YYYY-MM-DDTHH:MM:SSZ) - サプライヤーの有効期限

  • 住所(配列、オプション)

  • コード(文字列、必須、一意) - 住所コード

  • 名前(文字列、省略可能) - 住所名

  • 住所(文字列、必須) - 住所行

  • 市区町村(文字列、オプション) - 住所(市区町村)

  • 郵便番号(文字列、オプション) - 住所の郵便番号

  • 都道府県(文字列、オプション) - 住所の都道府県/地域

  • 国 (文字列、必須) - 住所の国コード

  • 既定(ブール値、オプション - 既定は false) - true の場合、サプライヤーの既定の住所になります。

  • 連絡先(配列、オプション)

  • 電話番号(文字列、電子メールがない場合は必須) - 電話番号に連絡

  • 電子メール(文字列、電話番号がない場合は必須) - 電子メールに連絡

  • 名前(文字列、オプション) - 連絡先名

  • 既定(ブール値、オプション - 既定は false) - true の場合、サプライヤーの既定の連絡先になります。

既定の住所/連絡先ルール:

  • 連絡先と住所は両方とも、既定の連絡先または住所をそれぞれ 1 つだけ持つことができます

  • サプライヤーが住所を持っている場合、いずれかの住所を既定の住所にする必要があります

  • サプライヤーが連絡先を持っている場合、連絡先の 1 つをデフォルトの連絡先にする必要があります

  • サプライヤーの作成または更新時に、既定の連絡先または住所が指定されていない場合、最初の連絡先または住所が既定の連絡先または住所になります

サプライヤーを作成する

POST /api/suppliers{?access_token}

ステータス: 使用可能

サプライヤーを作成するには、新しいサプライヤーの属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

POST /api/suppliers?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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 } ] }

応答 201

ボディ

{ "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 } ] }

応答 400

ボディ

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

サプライヤーを一覧表示

GET /api/suppliers{?access_token}

サプライヤーを一覧表示するには。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 のサプライヤーが表示されます。

URL の例

GET /api/suppliers?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

ID<so>ID

番号(オプション)

id でフィルタされたサプライヤーを一覧表示

コード

文字列(オプション)

コードでフィルタされたサプライヤーを一覧表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[ { "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 } ] } ]

応答 400Show

ボディ

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

サプライヤーを取得する

GET /api/suppliers/{id}{?access_token}

このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/suppliers/id?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ID<so>ID

数値(必須)

サプライヤー ID

リクエスト

ヘッダー

Content-Type: application/json

応答 201

ボディ

{ "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 } ] }

応答 400

ボディ

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

サプライヤーを更新する

追加 /api/suppliers/{id}{?access_token}

サプライヤーを更新するには、新しいサプライヤーの属性の JSON ハッシュを指定します。

連絡先

  • 指定されたサプライヤーの連絡先が、現在の連絡先を置き換えます。

  • 既存の連絡先と同じ名前の連絡先が指定された場合、その名前の連絡先の値は指定された連絡先の値に置き換えられます。

  • 連絡先が指定されていない場合、既存の連絡先は削除されます。

住所

  • 指定された住所が現在の住所を置き換えます。

  • 既存の住所と同じコードを持つ住所が指定された場合、そのコードを持つ住所の値は、指定された住所によって置き換えられます。

  • 住所が指定されていない場合、既存の住所は削除されます。

  • 住所にエンティティが関連付けられている場合、住所を削除できないため、要求は失敗します。

このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

追加 /api/suppliers/id?access_token=

URI パラメータ

ID

数値(必須)

クライアント ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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 } ] }

応答 201

ボディ

{ "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 } ] }

応答 400

ボディ

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

サプライヤーを削除する

DELETE /api/suppliers/{id}{?access_token}

URL の例

DELETE /api/suppliers/id?access_token=

URI パラメータ

ID

数値(必須)

サプライヤー ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 204

ボディ

Supplier was deleted

応答 412

ボディ

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

クライアント

Prodsmart API のクライアント リソースです。

CLIENT

単一のクライアント オブジェクトです。

クライアント リソースには次の属性があります。

  • id (指定値)

  • コード(文字列、必須、一意) -クライアント コード

  • 名前(文字列、必須) - クライアント名

  • 番号(文字列、オプション) - クライアント番号

  • 電話番号(文字列、オプション) - クライアントの電話番号

  • 電子メール(文字列、オプション) - クライアントの電子メール

  • 住所(配列、オプション)

  • コード(文字列、必須、一意) - 住所コード

  • 名前(文字列、省略可能) - 住所名

  • 住所(文字列、必須) - 住所行

  • 市区町村(文字列、オプション) - 住所(市区町村)

  • 郵便番号(文字列、オプション) - 住所の郵便番号

  • 都道府県(文字列、オプション) - 住所の都道府県/地域

  • 国 (文字列、必須) - 住所の国コード

  • 既定(ブール値、オプション - 既定は false) - true の場合、クライアントの既定の住所になります。

  • 連絡先(配列、オプション)

  • 電話番号(文字列、電子メールがない場合は必須) - 電話番号に連絡

  • 電子メール(文字列、電話番号がない場合は必須) - 電子メールに連絡

  • 名前(文字列、オプション) - 連絡先名

  • 既定(ブール値、オプション - 既定は false) - true の場合、クライアントの既定の連絡先になります

既定の住所/連絡先ルール:

  • 連絡先と住所は両方とも、既定の連絡先または住所をそれぞれ 1 つだけ持つことができます

  • クライアントに住所がある場合、いずれかの住所を既定にする必要があります

  • クライアントに連絡先がある場合、いずれかの連絡先を既定にする必要があります

  • クライアントの作成または更新時に、既定の連絡先または住所が指定されていない場合、最初の連絡先または住所が既定の連絡先または住所になります

クライアントを作成する

POST /api/clients{?access_token}

クライアントを作成するには、新しいクライアントの属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できるクライアントは 1 つだけです。将来的には、リクエストが 1 つのリソースではなく配列である場合、配列内のすべての項目が保存されるようになります。

URL の例

POST /api/clients?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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 } ] }

応答 201

ボディ

{ "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 } ] }

応答 400

ボディ

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

クライアントを一覧表示

GET /api/clients{?access_token}

クライアントを一覧表示します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 のクライアントが表示されます。

URL の例

GET /api/clients?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

ID<so>ID

番号(オプション)

id でフィルタされたクライアントを一覧表示

コード

文字列(オプション)

コードでフィルタされたクライアントを一覧表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[ { "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 } ] } ]

応答 400

ボディ

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

クライアントを取得する

GET /api/clients/{id}{?access_token}

このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/clients/id?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ID<so>ID

数値(必須)

クライアント ID

リクエスト

ヘッダー

Content-Type: application/json

応答 201

ボディ

{ "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 } ] }

応答 400

ボディ

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

クライアントを更新する

追加 /api/clients/{id}{?access_token}

クライアントを更新するには、新しいクライアントの属性の JSON ハッシュを指定します。

連絡先

  • 指定されたサプライヤーの連絡先が、現在の連絡先を置き換えます。

  • 既存の連絡先と同じ名前の連絡先が指定された場合、その名前の連絡先の値は指定された連絡先の値に置き換えられます。

  • 連絡先が指定されていない場合、既存の連絡先は削除されます。

住所

  • 指定された住所が現在の住所を置き換えます。

  • 既存の住所と同じコードを持つ住所が指定された場合、そのコードを持つ住所の値は、指定された住所によって置き換えられます。

  • 住所が指定されていない場合、既存の住所は削除されます。

  • 住所にエンティティが関連付けられている場合、住所を削除できないため、要求は失敗します。

このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

追加 /api/clients/id?access_token=

URI パラメータ

ID

数値(必須)

クライアント ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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    }  ]}

応答 201

ボディ

{ "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 } ] }

応答 400

ボディ

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

クライアントを削除する

DELETE /api/clients/{id}{?access_token}

URL の例

DELETE /api/clients/id?access_token=

URI パラメータ

ID

数値(必須)

クライアント ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 204

ボディ

Client was deleted

応答 412

ボディ

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

販売注文

Prodsmart API の クライアント注文リソースです。

販売注文

単一の販売注文オブジェクト。販売注文リソースは、Prodsmart API の最も重要なリソースの 1 つです。

販売注文リソースには次の属性があります。

  • id (指定値)

  • code (文字列、必須) - 販売注文コード

  • クライアント(文字列、オプション) - クライアント コード

  • 品目(文字列、オプション) - 販売注文の品目

  • 製品(配列、必須、空ではない)

    • コード(文字列、必須、一意) - 製品コード

    • 数量(倍精度実数、必須、>0) - 注文数量

    • 期日(日付、オプション、形式は YYYY-MM-DDTHH:MM:SSZ) - 発送予定日

    • 要求された日付(日付、オプション、形式 YYYY-MM-DDTHH:MM:SSZ) - 配送が要求された日付

    • 場所(文字列、オプション) - マルチサイトの場合は場所

    • 価格(倍精度実数、オプション) - 製品価格

  • パラメータ(文字列、オプション) - 受注固有の属性が含まれます。

販売注文を作成する

POST /api/client-order/{?access_token}

販売注文を作成するには、新しい販売注文の属性のJSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できる販売注文は 1 つだけです。将来的には、リクエストが 1 つのリソースではなく配列である場合、配列内のすべての項目が保存されるようになります。

URL の例

POST /api/client-order/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{  "code": "CO123 - Week 47",  "creation-date": "2022-04-19T08:30:01Z",  "client": "Client X",  "observations": "Ready next week",  "billing-address": "San Francisco",  "delivery-address": "Delivery address code",  "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,      "delivery-address":"San Francisco"    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z",      "price":502,      "delivery-address":"Los Angeles"    }  ],  "parameters": [    {      "name": "Sales Order Type",      "value": "Regular"    }  ]}

応答 201

ボディ

{  "id": 987356123,  "code": "CO123 - Week 47",  "creation-date": "2022-04-19T08:30:01Z",  "client": "Client X",  "billing-address":"San Francisco",  "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,      "delivery-address":"San Francisco"    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z",      "price":502,      "delivery-address":"Los Angeles"    }  ],  "parameters": [    {      "name": "Sales Order Type",      "value": "Regular"    }  ]}

応答 400

ボディ

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

販売注文をリストアップする

GET /api/client-order/{?access_token}

販売注文をリストアップするには: 複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 の販売注文が表示されます。

URL の例

GET /api/client-order/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

due-date-before

日付(オプション)

これより前の納期を持つ販売注文を一覧表示

due-date-after

日付(オプション)

これ以降に納期を迎える販売注文を一覧表示

クライアント<so>くらいあんと

文字列(オプション)

マシン コード

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[  {    "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      },      {        "code": "V23077",        "quantity": 99,        "due-date": "2016-08-16T17:15:15Z",        "requested-date": "2019-01-16T15:19:54Z"      }    ],    "parameters": [      {        "name": "Sales Order Type",        "value": "Regular"      }    ]  },  {    "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      },      {        "code": "V23077",        "quantity": 69,        "due-date": "2016-08-23T18:00:00Z",        "requested-date": "2019-01-16T15:19:54Z"      }    ],    "parameters": [      {        "name": "Sales Order Type",        "value": "Priority"      }    ]  }]

応答 400

ボディ

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

販売注文を取得する

GET /api/client-order/{id}{?access_token}

このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/client-order/id?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ID<so>ID

数値(必須)

販売注文 ID

リクエスト

ヘッダー

Content-Type: application/json

応答 201

ボディ

{  "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    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z"    }  ],  "parameters": [    {      "name": "Sales Order Type",      "value": "Priority"    }  ]}

応答 400

ボディ

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

販売注文を更新する

追加 /api/client-order/{?access_token}

販売注文を更新するには、新しい販売注文の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

追加 /api/client-order/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{  "code": "CO123 - Week 47",  "creation-date": "2022-04-19T08:30:01Z",  "client": "Client X",  "observations": "Ready next week",  "billing-address": "San Francisco",  "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,      "billing-address": "San Francisco"    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z",      "billing-address": "Los Angeles"    }  ]}

応答 201

ボディ

{  "id": 987356123,  "code": "CO123 - Week 47",  "creation-date": "2022-04-19T08:30:01Z",  "client": "Client X",  "billing-address": "San Francisco",  "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,      "billing-address": "San Francisco"    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z",      "billing-address": "Los Angeles"    }  ]}

応答 400

ボディ

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

販売注文を削除する

DELETE /api/client-order/{id}{?access_token}

URL の例

DELETE /api/client-order/id?access_token=

URI パラメータ

ID

数値(必須)

販売注文 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 204

ボディ

Client order was deleted

応答 409

ボディ

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

発注書

Prodsmart API の発注書のリソースです。

発注書

単一の発注書のオブジェクトです。発注書のリソースは、Prodsmart API の最も重要なリソースの 1 つです。

発注書のリソースには次の属性があります。

  • id (指定値)

  • コード(文字列、必須) - 発注書コード

  • サプライヤー(文字列、オプション) - サプライヤー コード

  • 請求先住所(文字列、オプション) - 請求先住所

  • 品目(文字列、オプション) - 発注書の品目

  • 製品(配列、必須、空ではない)

    • コード(文字列、必須、一意) - 製品コード

    • 数量(倍精度実数、必須、>0) - 数量リクエスト

    • 期日(日付、オプション、形式 YYYY-MM-DDTHH:MM:SSZ) - 受取期限日

    • 依頼日(日付、オプション、形式 YYYY-MM-DDTHH:MM:SSZ) - 受取要求日

    • 費用(倍精度実数、オプション) - :製品コスト

    • uom (文字列、オプション) - 製品の計測単位

  • 配送先住所(文字列、オプション) - 配送先住所

  • パラメータ(文字列、オプション) - 発注書パラメータ

  • 承認済みステータス(文字列、オプション) -下書き、レビュー中、承認済み、確認済み、却下

発注書を作成する

POST /api/purchase-orders/{?access_token}

発注書を作成するには、新しい発注書の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できる発注書は 1 つだけです。将来的には、リクエストが 1 つのリソースではなく配列である場合、配列内のすべての項目が保存されるようになります。

URL の例

POST /api/purchase-orders/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2023-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z"    }  ],  "approval-status": "draft",  "active": true}

応答 201

ヘッダー

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    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2023-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z"    }  ],  "approval-status": "draft",  "active": true}

応答 400

ボディ

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

発注書を取得する

GET /api/purchase-orders/{id}{?access_token}

このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/purchase-orders/id?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ID<so>ID

数値(必須)

発注書

リクエスト

ヘッダー

Content-Type: application/json

応答 201

ボディ

{  "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": "2023-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z"    }  ]}

応答 400

ボディ

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

発注書を更新する

追加/api/purchase-orders/{id}{?access_token}

発注書を更新するには、新しい発注書の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

追加 /api/purchase-orders/id?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ID<so>ID

数値(必須)

発注書

リクエスト

ヘッダー

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    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z"    }  ]}

応答 201

ボディ

{  "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    },    {      "code": "V23077",      "quantity": 99,      "due-date": "2016-08-16T17:15:15Z",      "requested-date": "2019-01-16T15:19:54Z"    }  ]}

応答 400

ボディ

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

発注書を削除する

DELETE /api/purchase-orders/{id}{?access_token}

URL の例

DELETE /api/purchase-orders/id?access_token=

URI パラメータ

ID

数値(必須)

発注書 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 204

ボディ

Purchase order was deleted

応答 409

ボディ

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

発注書を一覧表示する

GET /api/purchase-orders{?access_token}

発注書を一覧表示するには。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 の販売注文が表示されます。

URL の例

GET /api/purchase-orders?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

ID<so>ID

番号(オプション)

発注書 ID でフィルタされた発注書を一覧表示

コード

文字列(オプション)

発注書コードでフィルタされた発注書を一覧表示

due-date-before

日付(オプション)

これ以前の納期を持つ発注書を一覧表示

due-date-after

日付(オプション)

この後に納期を持つ発注書を一覧表示

サプライヤー

文字列(オプション)

サプライヤー コードでフィルタされた発注書を一覧表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

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

応答 400

ボディ

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

生産注文

Prodsmart API の生産注文のリソースです。

生産注文

単一の生産注文のオブジェクト。生産注文のリソースは、Prodsmart API の最も重要なリソースの 1 つです。これは、決められた期間中に決められた作業者によって決められた数量の製品を生産するという経営命令を表しています。

生産注文のリソースには次の属性があります。

  • id (指定値)

  • コード(文字列、必須) - 生産注文コード

  • 開始日(日付、日付、必須、形式 YYYY-MM-DDTHH:MM:SSZ) - 本生産注文の開始予定日

  • 期日(日付、必須、形式 YYYY-MM-DDTHH:MM:SSZ) - 本生産注文の提出期限

  • 製品(配列、必須、空ではない) - 注文された製品と数量

  • 製品(文字列、必須、一意) - 製品コード

  • 注文数量(整数、必須、>0) - 注文数量

  • 品目(オプション) - 本製品に関する注記

  • 生産数量(整数、供給済み、>0) - 生産数量

  • 説明(オプション) - この生産注文の説明

  • 出荷(オプション) - この注文の出荷コード

  • 作業員割り当て済み(配列、オプション) -

  • 番号 - 作業者番号

  • マシン(配列、オプション)

  • コード - マシン コード

  • シリアル番号(オプション)

  • 説明(オプション)

  • 注(オプション)

  • ステータス(提供済み) - スケジュール済み(開始日前および完全性 = 0)、予定どおり(終了日前および完全性 < 100%)、遅延(終了日後の完全性 < 100%)、完了済み(完全性 >= 100%)

  • 実行ステータス(供給済み) - 未開始(生産なし)、開始済み(生産あり)、完了(手動で完了または完成で完了)、アーカイブ済み(手動でアーカイブ済み)

ステータス ID は、作成時に Prodsmart API によって割り当てられます。

生産注文を取得する

GET /api/production-orders/{id}{?access_token}

生産注文を取得するには、生産注文 ID を使用して GET リクエストを実行するだけです。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/production-orders/id?access_token=

URI パラメータ

ID

数値(必須)

生産注文 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

作業者

boolean (オプション)

応答時に作業員リストを表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

{  "products": [    {      "product": "V23076",      "quantity-ordered": 3500,      "observations": "",      "quantity-produced": 700    }  ],  "code": "V23076 - Week 33/34",  "shipping": {    "code": "shipping 45"  },  "start-date": "2023-04-20T09:15:15Z",  "due-date": "2023-05-16T17:15:15Z",  "description": "Woodworks Ltd.",  "ended": false,  "custom-fields": [    {      "Order Type": "No changeover"    }  ],  "machines": [    {      "code": "A32"    }  ],  "pieces-by-box": 20,  "is-active": true,  "status": "onschedule",  "running-status": "started",  "notes": "",  "location":    {      "id": "location id",      "code": "location code",      "name": "location name"    },  "material-staging-complete": true,  "id": 3990}

生産注文を更新/置換する

追加 /api/production-orders/{id}{?access_token}

生産注文を更新するには、生産注文の ID を使用して PUT リクエストを実行するだけです。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

追加 /api/production-orders/id?access_token=

URI パラメータ

ID

数値(必須)

生産注文 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

作業者

boolean (オプション)

応答時に作業員リストを表示

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{  "products": [    {      "product": "V23076",      "quantity-ordered": 4000,      "observations": "",      "quantity-produced": 700    }  ],  "code": "V23076 - Week 33/34",  "shipping": {    "code": "shipping 45"  },  "start-date": "2023-04-20T09:15:15Z",  "due-date": "2023-05-16T17:15:15Z",  "description": "Woodworks Ltd.",  "ended": false,  "custom-fields": [    {      "Order Type": "No changeover"    }  ],  "machines": [    {      "code": "A32"    }  ],  "pieces-by-box": 20,  "is-active": true,  "status": "onschedule",  "running-status": "started",  "notes": "",  "location": "location code",  "material-staging-complete": true,  "id": 3990}

応答 200

ボディ

{  "products": [    {      "product": "V23076",      "quantity-ordered": 4000,      "observations": "",      "quantity-produced": 700    }  ],  "code": "V23076 - Week 33/34",  "shipping": {    "code": "shipping 45"  },  "start-date": "2023-04-20T09:15:15Z",  "due-date": "2023-05-16T17:15:15Z",  "description": "Woodworks Ltd.",  "ended": false,  "custom-fields": [    {      "Order Type": "No changeover"    }  ],  "machines": [    {      "code": "A32"    }  ],  "pieces-by-box": 20,  "is-active": true,  "status": "onschedule",  "running-status": "started",  "notes": "",  "location":    {      "id": "location id",      "code": "location code",      "name": "location name"    },  "material-staging-complete": true,  "id": 3990}

生産注文を削除する

DELETE /api/production-orders/{id}{?access_token}

URL の例

DELETE /api/production-orders/id?access_token=

URI パラメータ

ID

数値(必須)

生産注文 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 204

ボディ

Production order was deleted

生産注文を作成する

POST /api/production-orders/{?access_token}

生産注文を作成するには、新しい生産注文の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できる生産注文は 1 つだけです。将来的には、リクエストが 1 つのリソースではなく配列である場合、配列内のすべての項目が保存されるようになります。

URL の例

POST /api/production-orders/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

作業者

boolean (オプション)

応答時に作業員リストを表示

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{  "products": [    {      "product": "productExample",      "quantity-ordered": 4500,      "observations": ""    }  ],  "code": "exampleCode",  "shipping": "shippingExample",  "serial-number": "",  "description": "",  "start-date": "2023-07-20T09:15:15Z",  "due-date": "2023-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": "",  "location": "location code",  "active": true}

応答 201

ボディ

{    "products": [      {        "product": "productExample",        "quantity-ordered": 4500,        "observations": "",        "quantity-produced": 0      }    ],    "code": "exampleCode",    "shipping": "shippingExample",    "serial-number": "",    "description": "",    "start-date": "2023-07-20T09:15:15Z",    "due-date": "2023-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": "",    "location":      {        "id": "location id",        "code": "location code",        "name": "location name"      },    "active": true,    "id": 11110}

応答 400

ボディ

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

生産注文を一覧表示する

GET /api/production-orders/{?access_token}

生産注文を一覧表示するには。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 の OP が表示されます。

URL の例

GET /api/production-orders/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

start-date-before

日付(オプション)

この日以前に開始された生産注文を一覧表示

start-date-after

日付(オプション)

この日以降に開始された生産注文を一覧表示

due-date-before

日付(オプション)

この日以前に納期が到来する生産注文を一覧表示

due-date-after

日付(オプション)

この日以降に納期が到来する生産注文を一覧表示

実行ステータス

文字列(オプション)

未開始、開始済み、終了済み、アーカイブ済み

アクティブ<so>あくてぃぶ

boolean (オプション)

アクティブ(true)または非アクティブ(false)の生産注文のみを一覧表示します

製品

文字列(オプション)

製品コード<so>せいひんこーど

マシン

文字列(オプション)

マシン コード

作業者

boolean (オプション)

応答時に作業員リストを表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[  {    "products": [      {        "product": "exampleProduct",        "quantity-ordered": 4500,        "observations": "",        "quantity-produced": 0      }    ],    "code": "exampleCode",    "shipping": "Shipping 45",    "serial-number": "",    "description": "",    "start-date": "2023-07-20T09:15:15Z",    "due-date": "2023-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": "",    "location":      {        "id": "location id",        "code": "location code",        "name": "location name"      },    "active": true,    "id": 8763990  }]

生産注文の問題を通知する

POST /api/production-orders/{id}/notify{?access_token}

フィードにショート メッセージを投稿し、生産注文にメッセージを追加するサービスです。

  • ショート メッセージ(文字列、必須) - フィードに投稿されたメッセージ(最大長は 140 文字)

  • メッセージ(文字列、オプション) - 生産注文の注記セクションに追加されたメッセージ

URL の例

POST /api/production-orders/id/notify?access_token=

URI パラメータ

ID

数値(必須)

生産注文 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

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

応答 200

生産注文をアクティブ化する

POST /api/production-orders/{id}/activate{?access_token}

生産注文をアクティブにするサービスです。

URL の例

POST /api/production-orders/id/activate?access_token=

URI パラメータ

ID

数値(必須)

生産注文 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{}

応答 200

応答 204

ボディ

Production Order was already active

応答 405

ボディ

Production Order was closed or archived and cannot be activated

製品

Prodsmart API の製品リソース。

製品

単一の 製品オブジェクト製品リソースは、Prodsmart API の最も重要なリソースの 1 つです。ファクトリ内の製品を表し、生産に必要な作業を含んでいます。このメソッドは、新しい製品とその操作を作成します。また、次の用途にも使用できます

製品リソースには次の属性があります。

  • コード(文字列、必須) - 製品コード

  • 名前(文字列、必須) - 製品名

  • セクション(文字列、オプション)

  • ファミリ(配列、オプション)

  • 作業(配列、オプション) - 製品を生産するための作業

    • コード(文字列、必須) - 作業コード

    • 名前(文字列、必須) - 作業名

    • 不良品(配列、オプション)

    • タスク期間(配列、オプション、最大: 1)

      • 持続時間(時間、オプション、例: 「10H59m59s」形式) - 理論上は、この作業の実行にかかる平均時間

      • 期間 - 顧客(時間、オプション、例: 形式「10H59m59s」) - 予算で決められた時間

      • 比率 - 数量(倍精度実数、オプション、既定: 1.0) - この作業の各インスタンスで生成される体積

    • 製品ごとの回数(整数、オプション、既定: 1) - 製品ユニットを完了させるためにこの作業を実行する必要がある回数

    • カスタム フィールド(配列、オプション、システム上に存在する必要があります) - 作業に追加されるカスタム フィールド

      • 名前(文字列、必須) - システムで既に作成されているカスタム フィールド名

    • マシン(アレイ、オプション、システム上に存在する必要があります) - 作業を実行するために使用できるマシン

      • コード(文字列、必須) - システムで作成済みのマシン コード

    • 無効化(ブール値、オプション) - 作業を無効にします。

    • オプション(ブール値、オプション) - 作業をオプションとして設定します。

    • 回復(ブール値、オプション) - 作業を回復として設定します。

    • 時間なし(ブール値、オプション) - 生産時間を登録しません

    • 数量なし(ブール値、オプション) - 生産数量を登録しません

    • チームとして(ブール値、オプション) - チームとして実行する作業

    • 最大不良品しきい値(倍精度実数、オプション) - 許可される最大廃棄率

リクエストに存在しないフィールドは既定値で設定されます。既存の製品や作業でこの方法を使用する場合、存在しないフィールドは削除とみなされます。

製品を取得する

GET /api/products/{code}{?access_token}

製品を取得するには、製品のコードを使用して GET リクエストを実行するだけです。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/products/code?access_token=

URI パラメータ

コード

文字列(必須)

製品コード

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

{  "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}

応答 404

ボディ

If product with the provided code doesn't exist.

製品を作成する

POST /api/products{?access_token}

製品を作成するには、新しい製品とその作業の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。複数の作業を一度に作成できます。

URL の例

POST /api/products?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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.0,      "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}

応答 201

ボディ

{  "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.0,      "checklists": [        {          "code": "CheckIn"        }      ],      "custom-fields": null,      "machines":  [        {          "code": "OVEN02"        }      ],      "disabled": false,      "optional": false,      "recovery": null,      "no-time": false,      "no-quantity": false,      "as-team": false,      "section": {        "name": "CUT"      }      "id":560    }  ],  "custom-fields": null,  "parameters": [    {      "name": "parameter1",      "value": "value1"    },    {      "name": "parameter2",      "value": "2022-12-19T00:00:00Z"    }  ],  "serializable": true  "id":120}

応答 400

ボディ

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

製品を更新する

追加 /api/products/{code}{?access_token}

製品を更新するには、コードと、既存の製品とその作業の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できる製品は 1 つだけですが、複数の作業を一度に作成できます。

URL の例

PUT /api/products/code?access_token=

URI パラメータ

コード

文字列(必須)

製品コード

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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.0,      "checklists": [        {          "code": "CheckIn"        }      ],      "custom-fields": null,      "machines":  [        {          "code": "OVEN02"        }      ],      "disabled": false,      "optional": false,      "recovery": null,      "no-time": false,      "no-quantity": false,      "as-team": false,      "section": {        "name": "CUT"      }    }  ],  "custom-fields": null,  "parameters": [    {      "name": "parameter1",      "value": "value1"    },    {      "name": "parameter2",      "value": "2022-12-19T00:00:00Z"    }  ],  "serializable": true}

応答 201

ボディ

{  "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.0,      "checklists": [        {          "code": "CheckIn"        }      ],      "custom-fields": null,      "machines":  [        {          "code": "OVEN02"        }      ],      "disabled": false,      "optional": false,      "recovery": null,      "no-time": false,      "no-quantity": false,      "as-team": false,      "section": {        "name": "CUT"      }      "id":560    }  ],  "custom-fields": null,  "parameters": [    {      "name": "parameter1",      "value": "value1"    },    {      "name": "parameter2",      "value": "2022-12-19T00:00:00Z"    }  ],  "serializable": true  "id":120}

応答 400

ボディ

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

製品を削除する

DELETE /api/products/{code}{?access_token}

製品を削除するには、製品コードを指定します。

URL の例

DELETE /api/products/code?access_token=

URI パラメータ

コード

文字列(必須)

製品コード

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

Content-Type: application/json

応答 204

応答 400

ボディ

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

製品を一覧表示する

GET /api/products{?access_token}

製品とその作業を一覧表示します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/products?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

product-family-code

文字列(オプション)

提供された製品ファミリに属する製品を一覧表示

modification-date

日付(オプション)

指定された日付の後にバックオフィスで変更された製品を一覧表示します

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

{  "code": "P11",  "name": "Product 11",  "observations": "",  "section": null,  "unit-cost": null,  "unit-price": 4.32000,  "families": [    {      "code": "FG",      "name": "Finished Goods"    }  ],  "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"        }      ],      "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    }  ],  "components": [    {      "code": "SUGAR",      "name": "Sugar",      "quantity": 0.0015,      "operation": "MIXING"    },    {      "code": "VANILLA",      "name": "Vanilla",      "quantity": 0.0008,      "operation": "MIXING"    }  ],  "serializable": false,  "custom-fields": null}

応答 400

ボディ

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

製品の部品表

製品の部品表リソースは、特定の製品の製造に使用される材料を規定します。部品表には次の属性があります。

  • 製品コード - 主な製品

  • 部品表(配列、必須)

    • 製品コード(文字列、必須) - コンポーネント/消費製品コード

    • 数量(倍精度実数、必須) - 数量

    • 作業コード(文字列、必須) - 製品コードで定義された材料が使用される作業コード。空の場合、この製品の製造プロセスの最初の作業で消費されます。

製品の部品表を更新する

POST /api/bom{?access_token}

製品の部品表を更新するには、新しい製品とその作業の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

POST /api/bom?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

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

応答 201

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

応答 404

ボディ

Main product not found

応答 400

ボディ

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

製品ストック

ストックのリソースは、特定の製品に利用可能なストックを規定します。

  • 製品コード(文字列、必須)

  • ストック(倍精度実数、必須)

  • 日付(日付、オプション) - ストック数の日付

製品ストックを更新する

POST /api/stock{?access_token}

製品のストックを更新するには、現在のストックの属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

POST /api/stock?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

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

応答 201

ボディ

Request successful

応答 404

ボディ

Product not found

応答 400

ボディ

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

製品ファミリ

Prodsmart API の製品リソース。

製品ファミリ

製品ファミリ オブジェクトは、製品が属するファミリを表します。

製品ファミリ リソースには、次の属性があります。

  • コード(文字列、必須) - 製品ファミリ コード

  • 名前(文字列、必須) - 製品ファミリ名

製品ファミリを作成する

POST /api/product-families{?access_token}

1 つまたは複数の製品ファミリを作成するには。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

POST /api/product-families?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

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

応答 201

ボディ

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

応答 400

ボディ

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

製品ファミリを削除する

DELETE /api/product-family/{code}{?access_token}

製品ファミリを削除するには、ProductFamily コードを指定します

URL の例

DELETE /api/product-family/code?access_token=

URI パラメータ

コード

文字列(必須)

製品コード

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

Content-Type: application/json

応答 204

ボディ

Product Family was deleted

応答 400

ボディ

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

製品ファミリを一覧表示する

GET /api/product-families{?access_token}

製品ファミリを一覧表示するには。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/product-families?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

リクエスト

ヘッダー

Content-Type: application/json

応答 201

ボディ

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

応答 400

ボディ

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

マシン

Prodsmart API の生産リソース。

カウンタ

カウンタを更新する

POST /api/machines/{machine_code}/counter{?access_token}

マシンの現在のカウンタを更新するには、次のリクエストを送信します。マシン接続を簡素化するには、access_token を使用するか、基本認証を使用して認証ヘッダーに API 資格情報を送信します。Prodsmartは、そのマシン上で作業者によって開始された生産を自動的に更新します。数量カウントと不良品量は、どちらも増分である必要があります(つまり、以前に送信された数量より常に大きくなる必要があります)。

URL の例

POST /api/machines/machine_code/counter?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

machine_code

文字列(必須)

Prodsmart プラットフォームで定義されたマシン コード

リクエスト

ヘッダー

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    }  ]}

応答 200

ボディ

Returns the new value for the machine's counter.

応答 400

ボディ

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

パラメータ

パラメータを更新する

POST /api/machines/{machine_code}/parameters{?access_token}

マシン パラメータを更新するには、次のリクエストを送信するだけです。マシン接続を簡素化するには、access_token を使用するか、基本認証を使用して認証ヘッダーに API 資格情報を送信します。これらのパラメータが渡されると、生産記録が

URL の例

POST /api/machines/machine_code/parameters?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

machine_code

文字列(必須)

Prodsmart プラットフォームで定義されたマシン コード

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{  "parameters": [    {      "code": "temperature",      "value": 25    },    {      "code": "valid",      "value": "yes"    }  ]}

応答 200

ダウンタイム

ダウンタイムを更新する

POST /api/machines/{machine_code}/startstop{?access_token}

マシンの現在のステータスを更新するには、次のリクエストを送信するだけです。マシン接続を簡素化するには、access_token を使用するか、基本認証を使用して認証ヘッダーに API 資格情報を送信します。Prodsmart は、受信した情報にしたがって、ダウンタイムを自動的に登録または終了します。マシンが停止した場合は 0 を、オンになっている場合は 1 を送信し、ダウンタイムのタイプを指定します。

マシンのステータスを更新するには、次の属性を指定します。

  • タイプ(文字列、必須、マシンに既に割り当てられたダウンタイムのタイプである必要があります) - ダウンタイムのタイプ

  • 実行中(数値、必須、0 または 1) - マシンは停止(0)または実行中(1)ですか

URL の例

POST /api/machines/machine_code/startstop?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

machine_code

文字列(必須)

Prodsmart プラットフォームで定義されたマシン コード

リクエスト

ヘッダー

Content-Type: application/json

ボディ

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

応答 200

生産

Prodsmart API の生産リソース。

生産

単一の製品オブジェクト生産リソースは、Prodsmart API の中心的なリソースです。これは、一定期間における、あるポジションにおける 1人の作業者の労働を表します。

生産リソースには、次の属性があります。

  • ID

  • 開始時刻(日付、必須、形式 YYYY-MM-DDTHH:MM:SSZ) - 生産開始時刻

  • 終了時刻(日付、必須、形式 YYYY-MM-DDTHH:MM:SSZ) - 生産終了時刻

  • 作業時間(期間、指定、時刻 00H00m00s) - 生産作業時間(スケジュール時間/タイム レコーダー時間内、およびダウンタイムを除く)

  • 生産注文(オプション) - この生産が行われた生産注文

    • コード(文字列、必須) - 生産注文コード

    • ID (文字列、必須)

  • 作業(必須) - この生産から除外されたタスク

    • コード(文字列、必須、一意) - タスク コード

    • 製品(必須) - 作業者がこの地位で作業するという物理的利益

  • 数量(整数、必須、>0) - この生産の生産数量

  • 作業者(必須) - 仕事をする人

    • 数値(長整数、必須、一意): 作業者番号

  • 生成された不良品(配列、オプション) - 作業で排出される不良品

    • 数量(数値、必須) - 不良品コード

      • 不良品 - 不良品のタイプ

      • コード(文字列、必須、一意) - 不良品コード

      • 説明(文字列、必須) - 不良品の説明

      • 欠陥(文字列、必須) - 不良品タイプ

      • 数量(整数、必須) - 生成される不良品量

ステータス ID は、作成時に Prodsmart API によって割り当てられます。

生産を更新する

追加 /api/productions/{id}{?access_token}

生産を更新するには、コードと、既存の生産の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できる製品は 1 つだけですが、複数の作業を一度に作成できます。

URL の例

追加 /api/productions/id?access_token=

URI パラメータ

ID

数値(必須)

生産 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

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": "2023-07-20T09:15:15Z",  "end-time": "2023-07-20T09:15:16Z",  "lot-number": "other lot",  "finished": false}

応答 200

ボディ

{  "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": "2023-07-20T09:15:15.000Z",  "end-time": "2023-07-20T09:15:16.000Z",  "finished": false}

応答 400

ボディ

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

生産を削除する

DELETE /api/productions/{id}{?access_token}

生産を削除するには、生産 ID を指定します。

URL の例

DELETE /api/productions/id?access_token=

URI パラメータ

ID

数値(必須)

生産 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

Content-Type: application/json

応答 201

ボディ

{  "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": "2023-07-20T09:15:15.000Z",  "end-time": "2023-07-20T09:15:16.000Z",  "finished": false}

応答 400

ボディ

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

生産物を一覧表示する

GET /api/productions{?access_token}

生産物を一覧表示するには。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 の生産物が表示されます。

URL の例

GET /api/productions?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

生産注文 ID

数値(オプション)

この生産注文の生産物を一覧表示

生産注文コード

文字列(オプション)

この(またはこれらの)生産注文の生産物を一覧表示

作業者

数値(オプション)

この作業者(作業者番号)を含む生産物を一覧表示

start-time-before

日付(オプション)

この時間より前に開始された生産物を一覧表示

start-time-after

日付(オプション)

この時間より後に開始された生産物を一覧表示

end-time-before

日付(オプション)

この時間より前に終了した生産物の一覧表示

end-time-after

日付(オプション)

この時間より後に終了した生産物を一覧表示

開始時間

日付(オプション)

この開始時間以降に実行された生産物を一覧表示します(-before -after と組み合わせて使用しないでください)。

チェックアウト済み

boolean (オプション)

チェックアウトされている生産物を一覧表示

作業者名

boolean (オプション)

作業者の数だけではなく、作業者の名前と番号を取得します。

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[  {    "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": "2023-09-20T17:55:32.000+01:00",    "end-time": "2023-09-20T18:45:00.000+01:00",    "id": 575354  }]

ダウンタイム

Prodsmart API のダウンタイム リソース

ダウンタイム

ダウンタイムを一覧表示する

GET /api/downtimes{?access_token}

ダウンタイムを一覧表示するには。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/downtimes?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

start-time-before

日付(オプション)

この時間より前に開始されたダウンタイムを一覧表示

start-time-after

日付(オプション)

この時間より後に開始されたダウンタイムを一覧表示

end-time-before

日付(オプション)

この時間より前に終了したダウンタイムの一覧表示

end-time-after

日付(オプション)

この時間より後に終了したダウンタイムを一覧表示

マシン

数値(オプション)

このマシンのダウンタイムを一覧表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[  {    "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"  }]

タイム レコーダー

Prodsmart API のタイム レコーダー リソースです。

タイム レコーダー

Webhooks は、アプリの統合メニューからタイム レコーダー イベントに使用できます。この機能を使用するには、リッスンしたい通知イベントを含むエンドポイント URL コールバックを追加します。当社では、システムでイベントが発生するとすぐに Webhooks の通知を送信するよう努めています。現在、再試行はサポートされていません。

タイム レコーダーを一覧表示する

GET /api/punchclocks{?access_token}

タイム レコーダーを一覧表示するには。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/punchclocks?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

date-before

日付(オプション)

それ以前の日付のタイム レコーダー エントリを一覧表示

date-after

日付(オプション)

それ以降の日付のタイム レコーダー エントリを一覧表示

作業者

数値(オプション)

この作業者のタイム レコーダー エントリを一覧表示

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[{    "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')

在庫移動

Prodsmart API の在庫移動リソース。

在庫移動

単一の在庫移動オブジェクトです。在庫移動リソースは、Prodsmart API の最も重要なリソースの 1 つです。

在庫移動リソースには、次の属性があります。

  • id (指定値)

  • 製品(文字列、必須) - 製品コード

  • 日付時刻(日付、オプション、形式 YYYY-MM-DDTHH:MM:SSZ) - 在庫移動の作成日

  • 数量(倍精度実数、必須) - 在庫移動数量

  • タイプ(文字列、必須) - 在庫移動タイプ: イン、アウト、消費、生産

  • ロット(文字列、オプション) - 使用する在庫移動ロット

  • 総費用(浮動小数点数演算ライブラリ、オプション) - 数量に対する在庫移動の総費用

  • 倉庫 - 場所(文字列、オプション) -倉庫場所コード

  • 倉庫(文字列、オプション) - 倉庫コード

  • 場所(文字列、オプション) - マルチサイトの場合は場所

  • コメント(文字列、オプション) - 在庫移動コメント

在庫移動を取得する

GET /api/inventory-movements/{id}{?access_token}

在庫移動を取得するには、在庫移動の ID を使用して GET リクエストを実行するだけです。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/inventory-movements/id?access_token=

URI パラメータ

ID

数値(必須)

在庫移動 ID

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

{  "product-code": "ProductCode",  "date-time": "2018-07-20T09:15:15Z",  "quantity": "10",  "type": "in",  "lot": "A",  "total-cost": "1000",  "comment": "OK",  "warehouse-location": "Zone2",  "shipping": {    "code": "shippingCode",    "clientOrder": {      "code": "clientOrderCode",      "client": "clientCode"    },    "location": {      "id": "location id",      "code": "location code",      "name": "location name"    }  },  "receiving": {    "code": "receivingCode",    "purchaseOrder": {      "code": "purchaseOrderCode",      "supplier": "supplierCode"    },    "location": {      "id": "location id",      "code": "location code",      "name": "location name"    }  }}

在庫移動の作成

POST /api/inventory-movements/{?access_token}

在庫移動を作成するには、新しい在庫移動の属性の JSON ハッシュを指定します。このアクションには、productions_write 対象範囲を持つ access_token が必要です。現時点では、保存できる在庫移動は 1 つだけです。将来的には、リクエストが 1 つのリソースではなく配列である場合、配列内のすべての項目が保存されるようになります。

URL の例

POST /api/inventory-movements/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{  "product-code": "ProductCode",  "date-time": "2018-07-20T09:15:15Z",  "quantity": "10",  "type": "in",  "lot": "A",  "total-cost": "1000",  "comment": "OK",  "warehouse": "A",  "warehouse-location": "Zone2",  "location": "location code",  "shipping": "shippingCode",  "client-order": "clientOrderCode",  "receiving": "receivingCode",  "purchase-order": "purchaseOrderCode"}

応答 200

ボディ

{  "product-code": "ProductCode",  "date-time": "2018-07-20T09:15:15Z",  "quantity": "10",  "type": "in",  "lot": "A",  "total-cost": "1000",  "comment": "OK",  "warehouse-location": "Zone2",  "id": 12345,  "shipping": {    "code": "shippingCode",    "clientOrder": {      "code": "clientOrderCode",      "client": "clientCode"    },    "location": {      "id": "location id",      "code": "location code",      "name": "location name"    }  },  "receiving": {    "code": "receivingCode",    "purchaseOrder": {      "code": "purchaseOrderCode",      "supplier": "supplierCode"    },    "location": {      "id": "location id",      "code": "location code",      "name": "location name"    }  }}

応答 400

ボディ

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

在庫移動の更新

追加 /api/inventory-movements/{id}{?access_token}

在庫移動を更新するには、在庫移動で更新する属性を JSON に指定します(すべての属性はオプションです)。このアクションには、以下が必要です access_token 使用時 productions_write scope.

URL の例

追加 /api/inventory-movements/id?access_token=

URI パラメータ

ID

numeric (必須)

在庫移動 ID

access_token

string (必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

ボディ

{ "product-code": "ProductCode", "date-time": "2018-07-20T09:15:15Z", "quantity": "10", "type": "in", "lot": "A", "total-cost": "1000", "comment": "OK", "warehouse": "A", "warehouse-location": "Zone2", "receiving": "receivingCode" }

在庫移動の削除

DELETE /api/inventory-movement/{id}{?access_token}

在庫移動を削除するには、在庫移動 ID を指定します。

URL の例

DELETE /api/inventory-movement/id?access_token=

URI パラメータ

ID

numeric (必須)

在庫移動 ID

access_token

string (必須)

Prodsmart API アクセス トークン。

リクエスト

ヘッダー

Content-Type: application/json

応答 204

応答 400

It's not possible to delete this inventory-movement.

在庫移動を一覧表示

GET /api/inventory-movements/{?access_token}

在庫移動を一覧表示するには。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。このサービスはページ単位で提供され、1 ページにつき 25 の IM が表示されます。

URL の例

GET /api/inventory-movements/?access_token=

URI パラメータ

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

製品コード

文字列(オプション)

製品コード<so>せいひんこーど

種類

文字列(オプション)

在庫移動タイプ: イン、アウト、消費、生産

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[  {    "product-code": "ProductCode",    "date-time": "2018-07-20T09:15:15Z",    "quantity": "10",    "type": "in",    "lot": "A",    "total-cost": "1000",    "comment": "OK",    "warehouse-location": "Zone2",    "id": 12345,    "shipping": {      "code": "shippingCode",      "clientOrder": {        "code": "clientOrderCode",        "client": "clientCode"      },      "location": {        "id": "location id",        "code": "location code",        "name": "location name"      }    },    "receiving": {      "code": "receivingCode",      "purchaseOrder": {        "code": "purchaseOrderCode",        "supplier": "supplierCode"      },      "location": {        "id": "location id",        "code": "location code",        "name": "location name"      }    }  }]

ストック

Prodsmart API のストック リソースです。

製品ストックを取得する

GET /api/stock/{code}{?access_token}

製品ストックを取得するには、製品のコードを使用して GET リクエストを実行するだけです。複数のパラメータは AND 条件として扱われます。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/stock/code?access_token=

URI パラメータ

コード

文字列(必須)

製品コード

access_token

文字列(必須)

Prodsmart API アクセス トークン。

ロット

文字列(オプション)

製品のロットのロット コードとストック量を取得します

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

{"product-code": "Example","stock": 35,"lot": [     {      "code": "A",      "stock": 10    },    {      "code": "B",      "stock": 5    }}

応答 400

ボディ

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

レポート

Prodsmart API のレポート リソースです。

作業者労働時間

作業者労働時間 GET/api/reports/worker-labor-time{?access_token}

レポートを取得するには、時間間隔を指定して GET リクエストを実行するだけで、レポートが抽出されます。作業者とセクションのパラメータを追加して、レポートをフィルタできます。それに加えて、いくつかのフラグを指定して、レポートの内容をカスタマイズできます。すべてのフラグの既定値は false です。このアクションには、productions_write 対象範囲を持つ access_token が必要です。

URL の例

GET /api/reports/worker-labor-time?access_token=

URI パラメータ

開始時間

文字列(必須)

これ以降の日付のレポートを生成する(含む)

終了時間

文字列(必須)

これより前の日付のレポートを生成(含む)

access_token

文字列(必須)

Prodsmart API アクセス トークン

作業者番号

文字列(オプション)

作業者番号を指定して、レポートをファイタします

セクション

文字列(オプション)

セクション名を指定します。このセクションのすべての作業者がレポートに含まれます

再作業を表示

boolean (オプション)

再作業工程に関する新しいフィールドをレポートに含める

show-weekend

boolean (オプション)

データに週末を含める

only-punch-clock

boolean (オプション)

タイム レコーダー エントリのあるプレゼンス時間のみを考慮します

ページ

数値(オプション)

結果ページのインデックス、1 から始まる

リクエスト

ヘッダー

Content-Type: application/json

応答 200

ボディ

[  {    "worker": {      "number": "0",      "name": "John"    },    "presence-time": "08H00",    "work-time": "04H00m00s",    "percentage": "50%",    "calendar-downtimes": "00H00m00s"  },  {    "worker": {      "number": "1",      "name": "Mary"    },    "presence-time": "08H00",    "work-time": "08H00m00s",    "percentage": "100%",    "calendar-downtimes": "00H00m00s"  }]

応答 400

ボディ

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

応答 429

ボディ

Another request is ongoing for this endpoint. Please wait until the current request finishes before doing another.

アクセスの認証と制御

Prodsmart 認証トークンへのアクセスと制御

認証

認可リソースは、会社に付与された認可を表します。アクセスできるのは自分の認証のみです。使用される認証は基本認証であり、認証ヘッダーは、<base64 でエンコードされた値 API_KEY:API_SECRET> の形式になります。API キーとシークレットを取得するには、Prodsmart にログインし、ユーザを編集します。(注: それを取得するには、管理者の役割が必要です)。認証リソースには、以下の属性があります。

  • トークン

  • 範囲

ここで、taken はトークンを表し、scopes は指定された認証に付与されるスコープの配列です。現時点で利用可能なスコープは、次のとおりです productions_write.

権限を取得する

GET /api/authorization

既存のアクセス トークンを取得するには、GET を使用します。トークンがまだ存在しない場合は、POST メソッドを使用してトークンを生成できます。

URL の例

GET /api/authorization

リクエスト

ヘッダー

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

応答 200

ヘッダー

Content-Type: application/jsonLink: <http:/api.prodsmart.com/api/authorizations>;rel="self"

ボディ

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

認証を作成

POST /api/authorization

新しいアクセス トークンを生成するには、POST を使用します。

URL の例

POST /api/authorization

リクエスト

ヘッダー

Content-Type: application/jsonAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

ボディ

{ "scopes": [ "productions_write" ] }

応答 201

ヘッダー

Content-Type: application/jsonLink: <http:/api.prodsmart.com/api/authorizations>;rel="self"

ボディ

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

認証を削除

DELETE /api/authorization

URL の例

DELETE /api/authorization

リクエスト

ヘッダー

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

応答 204

関連記事
ラベル: タグ
Fusion Operations を Power BI に接続する
こちらの回答で解決しましたか？