Jumpseller Checkout Custom Fields API

openapi: 3.2.0
info:
  title: Jumpseller Com Checkout Custom Fields API
  version: 1.0.0
  x-logo:
    url: https://api.jumpseller.com/images/jumpseller-logo-full.svg
    altText: Jumpseller logo
    href: /
  description: 'Operations tagged Checkout Custom Fields across 2 of this provider''s published API definitions: jumpseller-com-openapi-openapi.json, jumpseller-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.jumpseller.com/v1
tags:
- name: Checkout Custom Fields
paths:
  /checkout_custom_fields.json:
    get:
      tags:
      - Checkout Custom Fields
      summary: Retrieve all Checkout Custom Fields
      security:
      - BasicAuthentication:
        - settings
      - loginParameter: []
        authtokenParameter: []
      - OAuth2:
        - read_settings
      parameters:
      - $ref: '#/components/parameters/LimitParam'
      - $ref: '#/components/parameters/PageParam'
      responses:
        '200':
          description: An array of Checkout Custom Fields
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CheckoutCustomField'
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/checkout_custom_fields.json"
      - lang: PHP
        label: PHP
        source: '<?php

          $login = ''XXXXX'';

          $authtoken = ''YYYYY'';

          $url = ''https://api.jumpseller.com/v1/checkout_custom_fields.json'';

          $ch = curl_init($url);

          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

          curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);

          curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);

          $response = curl_exec($ch);

          curl_close($ch);

          echo $response;'
      - lang: Ruby
        label: Ruby
        source: 'require ''net/http''

          require ''json''


          uri = URI(''https://api.jumpseller.com/v1/checkout_custom_fields.json'')

          http = Net::HTTP.new(uri.host, uri.port)

          http.use_ssl = true


          request = Net::HTTP::Get.new(uri)

          request.basic_auth(''XXXXX'', ''YYYYY'')

          request[''Content-Type''] = ''application/json''


          response = http.request(request)

          puts JSON.parse(response.body)'
      - lang: Python
        label: Python
        source: "import requests\n\nresponse = requests.get(\n    'https://api.jumpseller.com/v1/checkout_custom_fields.json',\n    auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
      - lang: JavaScript
        label: JavaScript
        source: "const response = await fetch('https://api.jumpseller.com/v1/checkout_custom_fields.json', {\n  method: 'GET',\n  headers: {\n    'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n    'Content-Type': 'application/json'\n  }\n});\n\nconst data = await response.json();\nconsole.log(data);"
      operationId: getCheckoutCustomFieldsJson
      x-operation-id-source: derived
    post:
      tags:
      - Checkout Custom Fields
      summary: Create a new CheckoutCustomField
      description: 'Type values can be: input, selection, checkbox, date or text. Area values can be: contact, billing_shipping or other.'
      security:
      - BasicAuthentication:
        - settings
      - loginParameter: []
        authtokenParameter: []
      - OAuth2:
        - write_settings
      parameters: []
      requestBody:
        description: CheckoutCustomField parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutCustomFieldEdit'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutCustomField'
        '404':
          description: CheckoutCustomField Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      x-codegen-request-body-name: body
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: "curl -u XXXXX:YYYYY -X POST \"https://api.jumpseller.com/v1/checkout_custom_fields.json\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"checkout_custom_field\": {\"label\": \"example\", \"type\": \"text\", \"area\": \"contact\", \"required\": true, \"position\": 1}}'"
      - lang: PHP
        label: PHP
        source: '<?php

          $login = ''XXXXX'';

          $authtoken = ''YYYYY'';

          $url = ''https://api.jumpseller.com/v1/checkout_custom_fields.json'';

          $ch = curl_init($url);

          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

          curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);

          curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);

          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ''POST'');

          curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([''checkout_custom_field'' => [''label'' => ''example'', ''type'' => ''text'', ''area'' => ''contact'', ''required'' => true, ''position'' => 1]]));

          $response = curl_exec($ch);

          curl_close($ch);

          echo $response;'
      - lang: Ruby
        label: Ruby
        source: 'require ''net/http''

          require ''json''


          uri = URI(''https://api.jumpseller.com/v1/checkout_custom_fields.json'')

          http = Net::HTTP.new(uri.host, uri.port)

          http.use_ssl = true


          request = Net::HTTP::Post.new(uri)

          request.basic_auth(''XXXXX'', ''YYYYY'')

          request[''Content-Type''] = ''application/json''

          request.body = { checkout_custom_field: { label: ''example'', type: ''text'', area: ''contact'', required: true, position: 1 } }.to_json


          response = http.request(request)

          puts JSON.parse(response.body)'
      - lang: Python
        label: Python
        source: "import requests\n\nresponse = requests.post(\n    'https://api.jumpseller.com/v1/checkout_custom_fields.json',\n    auth=('XXXXX', 'YYYYY'),\n    json={'checkout_custom_field': {'label': 'example', 'type': 'text', 'area': 'contact', 'required': True, 'position': 1}}\n)\nprint(response.json())"
      - lang: JavaScript
        label: JavaScript
        source: "const response = await fetch('https://api.jumpseller.com/v1/checkout_custom_fields.json', {\n  method: 'POST',\n  headers: {\n    'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n    'Content-Type': 'application/json'\n  },\n  body: JSON.stringify({\"checkout_custom_field\": {\"label\": \"example\", \"type\": \"text\", \"area\": \"contact\", \"required\": true, \"position\": 1}})\n});\n\nconst data = await response.json();\nconsole.log(data);"
      operationId: postCheckoutCustomFieldsJson
      x-operation-id-source: derived
    servers:
    - url: https://api.jumpseller.com/v1
  /checkout_custom_fields/{id}.json:
    get:
      tags:
      - Checkout Custom Fields
      summary: Retrieve a single CheckoutCustomField
      security:
      - BasicAuthentication:
        - settings
      - loginParameter: []
        authtokenParameter: []
      - OAuth2:
        - read_settings
      parameters:
      - name: id
        in: path
        description: Id of the CheckoutCustomField
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutCustomField'
        '404':
          description: CheckoutCustomField Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: curl -u XXXXX:YYYYY -X GET "https://api.jumpseller.com/v1/checkout_custom_fields/123.json"
      - lang: PHP
        label: PHP
        source: '<?php

          $login = ''XXXXX'';

          $authtoken = ''YYYYY'';

          $url = ''https://api.jumpseller.com/v1/checkout_custom_fields/123.json'';

          $ch = curl_init($url);

          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

          curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);

          curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);

          $response = curl_exec($ch);

          curl_close($ch);

          echo $response;'
      - lang: Ruby
        label: Ruby
        source: 'require ''net/http''

          require ''json''


          uri = URI(''https://api.jumpseller.com/v1/checkout_custom_fields/123.json'')

          http = Net::HTTP.new(uri.host, uri.port)

          http.use_ssl = true


          request = Net::HTTP::Get.new(uri)

          request.basic_auth(''XXXXX'', ''YYYYY'')

          request[''Content-Type''] = ''application/json''


          response = http.request(request)

          puts JSON.parse(response.body)'
      - lang: Python
        label: Python
        source: "import requests\n\nresponse = requests.get(\n    'https://api.jumpseller.com/v1/checkout_custom_fields/123.json',\n    auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
      - lang: JavaScript
        label: JavaScript
        source: "const response = await fetch('https://api.jumpseller.com/v1/checkout_custom_fields/123.json', {\n  method: 'GET',\n  headers: {\n    'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n    'Content-Type': 'application/json'\n  }\n});\n\nconst data = await response.json();\nconsole.log(data);"
      operationId: getCheckoutCustomFields{id}Json
      x-operation-id-source: derived
    put:
      tags:
      - Checkout Custom Fields
      summary: Update a CheckoutCustomField
      security:
      - BasicAuthentication:
        - settings
      - loginParameter: []
        authtokenParameter: []
      - OAuth2:
        - write_settings
      parameters:
      - name: id
        in: path
        description: Id of the CheckoutCustomField
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: CheckoutCustomField parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutCustomFieldEdit'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutCustomField'
        '404':
          description: CheckoutCustomField Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      x-codegen-request-body-name: body
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: "curl -u XXXXX:YYYYY -X PUT \"https://api.jumpseller.com/v1/checkout_custom_fields/123.json\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"checkout_custom_field\": {\"label\": \"example\", \"type\": \"text\", \"area\": \"contact\", \"required\": true, \"position\": 1}}'"
      - lang: PHP
        label: PHP
        source: '<?php

          $login = ''XXXXX'';

          $authtoken = ''YYYYY'';

          $url = ''https://api.jumpseller.com/v1/checkout_custom_fields/123.json'';

          $ch = curl_init($url);

          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

          curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);

          curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);

          curl_setopt($ch, CURLOPT_CUSTOMREQUEST, ''PUT'');

          curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([''checkout_custom_field'' => [''label'' => ''example'', ''type'' => ''text'', ''area'' => ''contact'', ''required'' => true, ''position'' => 1]]));

          $response = curl_exec($ch);

          curl_close($ch);

          echo $response;'
      - lang: Ruby
        label: Ruby
        source: 'require ''net/http''

          require ''json''


          uri = URI(''https://api.jumpseller.com/v1/checkout_custom_fields/123.json'')

          http = Net::HTTP.new(uri.host, uri.port)

          http.use_ssl = true


          request = Net::HTTP::Put.new(uri)

          request.basic_auth(''XXXXX'', ''YYYYY'')

          request[''Content-Type''] = ''application/json''

          request.body = { checkout_custom_field: { label: ''example'', type: ''text'', area: ''contact'', required: true, position: 1 } }.to_json


          response = http.request(request)

          puts JSON.parse(response.body)'
      - lang: Python
        label: Python
        source: "import requests\n\nresponse = requests.put(\n    'https://api.jumpseller.com/v1/checkout_custom_fields/123.json',\n    auth=('XXXXX', 'YYYYY'),\n    json={'checkout_custom_field': {'label': 'example', 'type': 'text', 'area': 'contact', 'required': True, 'position': 1}}\n)\nprint(response.json())"
      - lang: JavaScript
        label: JavaScript
        source: "const response = await fetch('https://api.jumpseller.com/v1/checkout_custom_fields/123.json', {\n  method: 'PUT',\n  headers: {\n    'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n    'Content-Type': 'application/json'\n  },\n  body: JSON.stringify({\"checkout_custom_field\": {\"label\": \"example\", \"type\": \"text\", \"area\": \"contact\", \"required\": true, \"position\": 1}})\n});\n\nconst data = await response.json();\nconsole.log(data);"
      operationId: putCheckoutCustomFields{id}Json
      x-operation-id-source: derived
    delete:
      tags:
      - Checkout Custom Fields
      summary: Delete an existing CheckoutCustomField
      security:
      - BasicAuthentication:
        - settings
      - loginParameter: []
        authtokenParameter: []
      - OAuth2:
        - write_settings
      parameters:
      - name: id
        in: path
        description: Id of the CheckoutCustomField
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '404':
          description: CheckoutCustomField Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
      x-codeSamples:
      - lang: Shell
        label: cURL
        source: curl -u XXXXX:YYYYY -X DELETE "https://api.jumpseller.com/v1/checkout_custom_fields/123.json"
      - lang: PHP
        label: PHP
        source: '<?php

          $login = ''XXXXX'';

          $authtoken = ''YYYYY'';

          $url = ''https://api.jumpseller.com/v1/checkout_custom_fields/123.json'';

          $ch = curl_init($url);

          curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

          curl_setopt($ch, CURLOPT_USERPWD, $login . '':'' . $authtoken);

          curl_setopt($ch, CURLOPT_HTTPHEADER, [''Content-Type: application/json'']);

          $response = curl_exec($ch);

          curl_close($ch);

          echo $response;'
      - lang: Ruby
        label: Ruby
        source: 'require ''net/http''

          require ''json''


          uri = URI(''https://api.jumpseller.com/v1/checkout_custom_fields/123.json'')

          http = Net::HTTP.new(uri.host, uri.port)

          http.use_ssl = true


          request = Net::HTTP::Delete.new(uri)

          request.basic_auth(''XXXXX'', ''YYYYY'')

          request[''Content-Type''] = ''application/json''


          response = http.request(request)

          puts JSON.parse(response.body)'
      - lang: Python
        label: Python
        source: "import requests\n\nresponse = requests.delete(\n    'https://api.jumpseller.com/v1/checkout_custom_fields/123.json',\n    auth=('XXXXX', 'YYYYY')\n)\nprint(response.json())"
      - lang: JavaScript
        label: JavaScript
        source: "const response = await fetch('https://api.jumpseller.com/v1/checkout_custom_fields/123.json', {\n  method: 'DELETE',\n  headers: {\n    'Authorization': 'Basic ' + btoa('XXXXX:YYYYY'),\n    'Content-Type': 'application/json'\n  }\n});\n\nconst data = await response.json();\nconsole.log(data);"
      operationId: deleteCheckoutCustomFields{id}Json
      x-operation-id-source: derived
    servers:
    - url: https://api.jumpseller.com/v1
components:
  schemas:
    CheckoutCustomFieldEditFields:
      type: object
      properties:
        label:
          type: string
          description: Label given to the CheckoutCustomField
        type:
          type: string
          description: Type of the CheckoutCustomField
          enum:
          - text
          - select
          - input
          - checkbox
          - date
        area:
          type: string
          description: Area of the CheckoutCustomField
          enum:
          - contact
          - billing_shipping
          - other
        required:
          type: boolean
          description: True if the CheckoutCustomField is mandatory
          default: false
        position:
          type: integer
          description: Position of the CheckoutCustomField
          format: int32
        deletable:
          type: boolean
          description: True if the CheckoutCustomField can be removed from the store
          default: false
        custom_field_select_options:
          type: array
          description: The values for the CheckoutCustomField selection
          items:
            type: string
    CheckoutCustomFieldEdit:
      type: object
      properties:
        checkout_custom_field:
          $ref: '#/components/schemas/CheckoutCustomFieldEditFields'
    NotFound:
      type: object
      properties:
        message:
          type: string
    CheckoutCustomField:
      type: object
      properties:
        checkout_custom_field:
          $ref: '#/components/schemas/CheckoutCustomFieldFields'
    CheckoutCustomFieldFields:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the CheckoutCustomField
          format: int32
        label:
          type: string
          description: Label given to the CheckoutCustomField
        type:
          type: string
          description: Type of the CheckoutCustomField
          enum:
          - text
          - select
          - input
          - checkbox
        area:
          type: string
          description: Area of the CheckoutCustomField
          enum:
          - contact
          - billing_shipping
          - other
        required:
          type: boolean
          description: True if the CheckoutCustomField is mandatory
          default: false
        position:
          type: integer
          description: Position of the CheckoutCustomField
          format: int32
        deletable:
          type: boolean
          description: True if the CheckoutCustomField can be removed from the store
          default: false
        custom_field_select_options:
          type: array
          description: The values for the CheckoutCustomField selection
          items:
            type: string
    CheckoutCustomFieldEditFields_2:
      type: object
      properties:
        label:
          type: string
          description: Label given to the CheckoutCustomField. Required on create.
        type:
          type: string
          description: Type of the CheckoutCustomField. Required on create.
          enum:
          - text
          - selection
          - input
          - checkbox
          - date
        area:
          type: string
          description: Area of the CheckoutCustomField. Required on create.
          enum:
          - contact
          - billing_shipping
          - other
        required:
          type: boolean
          description: True if the CheckoutCustomField is mandatory
          default: true
        position:
          type: integer
          description: Position of the CheckoutCustomField
          format: int32
          default: 1
        deletable:
          type: boolean
          description: True if the CheckoutCustomField can be removed from the store
          default: true
        is_date_restricted:
          type: boolean
          description: 'For ''date'' fields: only allow today or future dates'
          default: false
        custom_field_select_options:
          type: array
          description: The options of a 'selection' CheckoutCustomField
          items:
            type: string
    MessageObject:
      type: object
      properties:
        message:
          type: string
    CheckoutCustomFieldFields_2:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the CheckoutCustomField
          format: int32
        label:
          type: string
          description: Label given to the CheckoutCustomField
        type:
          type: string
          description: Type of the CheckoutCustomField
          enum:
          - text
          - selection
          - input
          - checkbox
          - date
        area:
          type: string
          description: Area of the CheckoutCustomField
          enum:
          - contact
          - billing_shipping
          - other
        required:
          type: boolean
          description: True if the CheckoutCustomField is mandatory
          default: true
        position:
          type: integer
          description: Position of the CheckoutCustomField
          format: int32
        deletable:
          type: boolean
          description: True if the CheckoutCustomField can be removed from the store
          default: true
        app_id:
          type:
          - integer
          - 'null'
          description: Id of the App that created the CheckoutCustomField
          format: int32
        checkout_custom_field_select_options:
          type: array
          description: The options of a 'selection' CheckoutCustomField
          items:
            type: object
            properties:
              value:
                type: string
  parameters:
    PageParam:
      name: page
      in: query
      description: List page
      schema:
        type: integer
        format: integer
        default: 1
    LimitParam:
      name: limit
      in: query
      description: List restriction
      schema:
        maximum: 100
        type: integer
        format: integer
        default: 50
    PageParam_2:
      name: page
      in: query
      description: Page number, starting at 1.
      schema:
        type: integer
        default: 1
        minimum: 1
    LimitParam_2:
      name: limit
      in: query
      description: Number of objects per page (maximum 100).
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 100
  securitySchemes:
    BasicAuthentication:
      type: http
      scheme: basic
      description: Basic authentication in the format of `login:authtoken` or `partner_code:auth_token`.
    loginParameter:
      type: apiKey
      in: query
      name: login
      description: API OAuth login. Learn how to get yours [here](#section/Authentication).
    authtokenParameter:
      type: apiKey
      in: query
      name: authtoken
      description: API OAuth token. Learn how to get yours [here](#section/Authentication).
    auth_tokenParameter:
      type: apiKey
      in: query
      name: auth_token
      description: Partner authentication token.
    OAuth2:
      type: oauth2
      description: OAuth 2.0 authorization code flow. Register your app at the Jumpseller Admin Panel to get client credentials. See https://jumpseller.com/support/oauth-2/ for details.
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.jumpseller.com/oauth/authorize
          tokenUrl: https://accounts.jumpseller.com/oauth/token
          refreshUrl: https://accounts.jumpseller.com/oauth/token
          scopes:
            read_products: Read products, variants, images, options, and custom fields
            write_products: Create, update, and delete products
            read_orders: Read orders, fulfillments, and order history
            write_orders: Create, update, and refund orders
            read_customers: Read customer accounts and groups
            write_customers: Create, update, and delete customers
            read_categories: Read product categories
            write_categories: Create, update, and delete categories
            read_store: Read store information and settings
            write_store: Update store settings
            read_settings: Read store configuration
            write_settings: Update store configuration
            read_shipping_methods: Read shipping methods and rates
            write_shipping_methods: Create and update shipping methods
            read_payment_methods: Read payment methods
            write_payment_methods: Create and update payment methods
            read_hooks: Read webhooks
            write_hooks: Create, update, and delete webhooks
            read_promotions: Read promotions and discounts
            write_promotions: Create, update, and delete promotions
            read_taxes: Read tax rules
            write_taxes: Create and update tax rules
            read_pages: Read store pages
            write_pages: Create, update, and delete pages
            read_countries: Read country information
            write_countries: Update country settings
            read_custom_fields: Read product custom fields
            write_custom_fields: Create and update custom fields
            read_checkout_custom_fields: Read checkout additional fields
            write_checkout_custom_fields: Update checkout additional fields
            read_customer_categories: Read customer categories
            write_customer_categories: Create and update customer categories
            read_jsapps: Read JavaScript apps
            write_jsapps: Create, update, and delete JavaScript apps
            read_apps: Read installed apps
            read_fulfillments: Read fulfillment information
            write_fulfillments: Create and update fulfillments
            read_locations: Read warehouse locations
            write_locations: Create and update locations
            write_reviews: Manage product reviews
            read_transaction_ledgers: Read store balance
            write_store_setup: Create new stores via the store setup endpoint
x-refined-from:
- jumpseller-com-openapi-openapi.json
- jumpseller-com-openapi.json