Import price entries

Replaces the book’s entries for the products named; a volume tier belongs to its entry.

POST/api/v1/price-books/{id}/entries

認証

AuthorizationOAuth2 アクセストークン · header必須

Authorization-code grant with PKCE. Clients are public and hold no secret. Discovery is published at /.well-known/oauth-authorization-server/api/auth.

スコープ:api.access

パスパラメーター

idstring必須

A price book's id

最小長 1 · 最大長 255

ヘッダーパラメーター

Idempotency-Keystring必須

Replays the first answer for a repeated request

最小長 8 · 最大長 128

リクエストボディ

必須application/json

entriesobject[]必須

最小項目数 1 · 最大項目数 500

プロパティを表示

object の配列

minimumQuantitystring

^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致 · デフォルト: "0"

productIdstring必須

最小長 1 · 最大長 255

unitPricestring必須

^-?(?:0|[1-9]\d{0,15})(?:\.\d{1,8})?$ に一致

validFromstring<date>必須

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ に一致

validUntilstring<date> | null

デフォルト: null

プロパティを表示

いずれか:

string<date>

string<date>

null

null

レスポンス

201

The entries that were written

entriesobject[]必須

プロパティを表示

object の配列

idstring必須

最小長 1 · 最大長 255

400

The request body, query or parameters were refused

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

401

The access token is missing, invalid or revoked

errorstring必須

403

The tenant's module is off, or the token's scope or the member's role does not permit the action

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

404

No such record, or none the caller may read

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

409

The operation conflicts with the current state

codestring必須

許可される値:invalid_inputnot_foundconflictforbidden

detailany

errorstring必須

reasonstring

413

The request exceeds the route's body limit

errorstring必須

500

An unexpected failure

errorstring必須

リクエスト

curl -X POST '/api/v1/api/v1/price-books/string/entries' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Idempotency-Key: stringst' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "entries": [
    {
      "minimumQuantity": "0",
      "productId": "string",
      "unitPrice": "string",
      "validFrom": "2019-08-24",
      "validUntil": null
    }
  ]
}'

const response = await fetch("/api/v1/api/v1/price-books/string/entries", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN",
    "Idempotency-Key": "stringst",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"entries\": [\n    {\n      \"minimumQuantity\": \"0\",\n      \"productId\": \"string\",\n      \"unitPrice\": \"string\",\n      \"validFrom\": \"2019-08-24\",\n      \"validUntil\": null\n    }\n  ]\n}"
});

import requests

response = requests.post(
    "/api/v1/api/v1/price-books/string/entries",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN",
        "Idempotency-Key": "stringst",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"entries\": [\n    {\n      \"minimumQuantity\": \"0\",\n      \"productId\": \"string\",\n      \"unitPrice\": \"string\",\n      \"validFrom\": \"2019-08-24\",\n      \"validUntil\": null\n    }\n  ]\n}",
)

レスポンス

{
  "entries": [
    {
      "id": "string"
    }
  ]
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "code": "invalid_input",
  "detail": null,
  "error": "string",
  "reason": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}