Skip to content

Complete entry

Marks an entry complete for the customer.

Needs the progress:write scope.

Call

  • Tool: complete_entry
  • Scope: progress:write
  • Writes, adding without changing what is there.
  • Acts on a store.

Arguments

Name Type Required Description
product object Yes
entry object Yes
preview string No A token a seller made for the entry’s product’s page, which opens a published entry of the product unpublished, or for the entry itself, which opens it unpublished too, gated as ever; with it, any entry it does not open is not_found preview.
{
  "type": "object",
  "properties": {
    "product": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "entry": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "id"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "product": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 512
                    }
                  },
                  "required": [
                    "id"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "slug": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 512
                    }
                  },
                  "required": [
                    "slug"
                  ],
                  "additionalProperties": false
                }
              ]
            },
            "slug": {
              "type": "string",
              "minLength": 1,
              "maxLength": 512
            }
          },
          "required": [
            "product",
            "slug"
          ],
          "additionalProperties": false
        }
      ]
    },
    "preview": {
      "description": "A token a seller made for the entry's product's page, which opens a published entry of the product unpublished, or for the entry itself, which opens it unpublished too, gated as ever; with it, any entry it does not open is `not_found` `preview`.",
      "type": "string",
      "minLength": 1,
      "maxLength": 128
    }
  },
  "required": [
    "product",
    "entry"
  ],
  "additionalProperties": false
}

Answer

Name Type Required Description
entry_id string Yes
product_id string Yes
completed_at string Yes
certificates array of object Yes

The answer’s full shape is on its API reference page.

Type to search…

↑↓ navigate↵ selectEsc close