Zum Hauptinhalt springen
POST
/
crm
/
v3
/
objects
/
orders
/
batch
/
upsert
固有のプロパティー値を基準に注文をバッチ作成またはバッチ更新
curl --request POST \
  --url https://api.hubapi.com/crm/v3/objects/orders/batch/upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": [
    {
      "id": "<string>",
      "idProperty": "<string>",
      "objectWriteTraceId": "<string>",
      "properties": {}
    }
  ]
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "errors": [
    {
      "category": "<string>",
      "context": {},
      "errors": [
        {
          "code": "<string>",
          "context": "{missingScopes=[scope1, scope2]}",
          "in": "<string>",
          "message": "<string>",
          "subCategory": "<string>"
        }
      ],
      "id": "<string>",
      "links": {},
      "message": "<string>",
      "status": "<string>",
      "subCategory": {}
    }
  ],
  "links": {},
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "new": true,
      "objectWriteTraceId": "<string>",
      "properties": {},
      "propertiesWithHistory": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
crm.objects.orders.write

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
objectType
string
required

バッチ更新／挿入処理で処理するオブジェクトのタイプ。

Body

application/json
​
inputs
object[]
required

Response

successful operation

Represents the result of a batch upsert operation, including the operation’s status, timestamps, and a list of successfully created or updated objects.

​
completedAt
string<date-time>
required

The timestamp when the batch process was completed, in ISO 8601 format.

​
results
object[]
required
​
startedAt
string<date-time>
required

The timestamp when the batch process began execution, in ISO 8601 format.

​
status
enum<string>
required

The status of the batch processing request. Can be: "PENDING", "PROCESSING", "CANCELED", or "COMPLETE".

Verfügbare Optionen:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
​
errors
object[]
​
links
object

An object containing relevant links related to the batch request.

​
numErrors
integer
​
requestedAt
string<date-time>

The timestamp when the batch process was initiated, in ISO 8601 format.