POST api/store/{id}/checkoutforms/import

Import a list of checkout forms from a store

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Store Identifier	integer	Required

Body Parameters

List of checkout forms to import

Collection of CheckoutForm

Name	Type	Additional information
ID	integer	None.
G_UID	Collection of byte	None.
Guid	globally unique identifier	None.
ZoneID	integer	None.
StoreID	integer	None.
Name	string	None.
FormType	string	None.
LocationX	integer	None.
LocationY	integer	None.
Width	integer	None.
Height	integer	None.
Maximised	boolean	None.
Resizable	boolean	None.
BackgroundImage	string	None.
BackgroundColour	string	None.
BackgroundColourA	integer	None.
BackgroundColourR	integer	None.
BackgroundColourG	integer	None.
BackgroundColourB	integer	None.
FontFamily	string	None.
FontSize	decimal number	None.
FontStyle	integer	None.
PreviousForm	integer	None.
PreviousFormG_UID	Collection of byte	None.
PreviousFormGuid	globally unique identifier	None.
NextForm	integer	None.
NextFormG_UID	Collection of byte	None.
NextFormGuid	globally unique identifier	None.
Attributes	string	None.
Updated	date	None.
Positioning	integer	None.
ContentPanel	string	String length: inclusive between 0 and 60
SelectionMode	integer	None.
MaximumSelections	integer	None.
AlteredInStore	boolean	None.
Deleted	boolean	None.
BlueprintID	integer	None.
PreserveLayout	boolean	None.
MainCheckoutFormName	string	None.
NextCheckoutForm	CheckoutForm	None.
PreviousCheckoutForm	CheckoutForm	None.
Buttons	Collection of CheckoutButton	None.
Panels	Collection of CheckoutPanel	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "$id": "1",
    "id": 1,
    "g_UID": "gjgjEzMHLkOSG6rDhyilcA==",
    "guid": "13233882-0733-432e-921b-aac38728a570",
    "zoneID": 3,
    "storeID": 4,
    "name": "sample string 5",
    "formType": "sample string 6",
    "locationX": 1,
    "locationY": 1,
    "width": 1,
    "height": 1,
    "maximised": true,
    "resizable": true,
    "backgroundImage": "sample string 7",
    "backgroundColour": "sample string 8",
    "backgroundColourA": 1,
    "backgroundColourR": 1,
    "backgroundColourG": 1,
    "backgroundColourB": 1,
    "fontFamily": "sample string 9",
    "fontSize": 1.1,
    "fontStyle": 1,
    "previousForm": 1,
    "previousFormG_UID": "P8Ke+ZFBDkW/WDKxKG/rLg==",
    "previousFormGuid": "f99ec23f-4191-450e-bf58-32b1286feb2e",
    "nextForm": 1,
    "nextFormG_UID": "1KfXSRu66kyvl6ajkKbw4A==",
    "nextFormGuid": "49d7a7d4-ba1b-4cea-af97-a6a390a6f0e0",
    "attributes": "sample string 10",
    "updated": "2025-08-02T23:27:05.5830712",
    "positioning": 1,
    "contentPanel": "sample string 11",
    "selectionMode": 1,
    "maximumSelections": 1,
    "alteredInStore": true,
    "deleted": true,
    "blueprintID": 1,
    "preserveLayout": true,
    "mainCheckoutFormName": "sample string 13",
    "nextCheckoutForm": {
      "$ref": "1"
    },
    "previousCheckoutForm": {
      "$ref": "1"
    },
    "buttons": [
      {
        "$id": "2",
        "id": 1,
        "checkoutFormID": 2,
        "checkoutFormG_UID": "jHXtsuLUQkui7MhJp5jhwg==",
        "checkoutFormGuid": "b2ed758c-d4e2-4b42-a2ec-c849a798e1c2",
        "identifier": "NHAc3kJY1kK0qlwCWwsaQg==",
        "identifierGuid": "de1c7034-5842-42d6-b4aa-5c025b0b1a42",
        "name": "sample string 5",
        "plu": 1,
        "locationX": 1,
        "locationY": 1,
        "width": 1,
        "height": 1,
        "anchor": 1,
        "backgroundImage": "sample string 6",
        "backgroundImageID": 1,
        "backgroundImageUrl": "sample string 7",
        "topColour": 1,
        "textColour": 1,
        "bottomColour": 1,
        "borderColour": 1,
        "borderWidth": 1,
        "radius": 1,
        "gradientMode": 1,
        "dropShadow": true,
        "shadowWidth": 1,
        "highLightOnPush": true,
        "fontFamily": "sample string 8",
        "fontSize": 1.1,
        "fontStyle": 1,
        "textAlign": 1,
        "imageAlign": 1,
        "wordBreak": true,
        "verticalText": true,
        "buttonFunction": 1,
        "buttonValue": 1,
        "valueG_UID": "0XYW7bFo/0W1aQGKGv47IA==",
        "valueGuid": "ed1676d1-68b1-45ff-b569-018a1afe3b20",
        "buttonText": "sample string 10",
        "valueText": "sample string 11",
        "drawImageAndButton": true,
        "updated": "2025-08-02T23:27:05.5830712",
        "action": "sample string 12",
        "valueForm": {
          "$ref": "1"
        },
        "image": {
          "$id": "3",
          "name": "sample string 3.sample string 4",
          "imageID": 2,
          "imageName": "sample string 3",
          "imageExtension": "sample string 4",
          "lastUpdate": "2025-08-02T23:27:05.5830712",
          "imageData": "QEA=",
          "readOnly": true
        }
      },
      {
        "$ref": "2"
      }
    ],
    "panels": [
      {
        "$id": "4",
        "id": 1,
        "checkoutFormID": 2,
        "checkoutFormG_UID": "RjZ37e8aWUiNSO2HINg/yw==",
        "checkoutFormGuid": "ed773646-1aef-4859-8d48-ed8720d83fcb",
        "panelType": "sample string 4",
        "name": "sample string 5",
        "locationX": 6,
        "locationY": 7,
        "width": 8,
        "height": 9,
        "anchor": 10,
        "fontFamily": "sample string 11",
        "fontSize": 12.1,
        "fontStyle": 13,
        "backgroundColour": 14,
        "textColour": 15,
        "attributes": "sample string 16"
      },
      {
        "$ref": "4"
      }
    ]
  },
  {
    "$ref": "1"
  }
]

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.