{
  "openapi": "3.0.1",
  "info": {
    "title": "Storefront API",
    "description": "The Storefront API gives an online shop the catalogue, stock, checkout and order tracking of a store that trades on Biz Edge RetailPOS.\n\nOne API key is one storefront. The key fixes the company, branch, till and store every call works against, so no request carries a company or branch id.\n\n## Base URL\n`https://storefrontapi.bizedgehq.com`. Every endpoint is under `/v1`.\n\n## Getting started\n1. Get your storefront's API key from Biz Edge. It is issued when your storefront is set up. Keep it on your server: it identifies your store, and every shopper shares its rate limit.\n2. Paste the key into **Authentication** on this page.\n3. Open **Storefront › Detail** and press **Test Request**. An `errorCode` of 0 means the key works.\n\n## Authentication\nSend the key in an `X-API-Key` header on every request.\n\n## Responses\nEvery response is **HTTP 200**, failures included, with the same envelope:\n\n```json\n{ \"errorCode\": 0, \"errorMessage\": \"\", \"data\": { } }\n```\n\n`errorCode` 0 is success. Anything else is a failure, and `data` is null, except on **Stock › Check cart stock**, whose failure still lists the short items. Check `errorCode`, not the HTTP status.\n\n| Code | Meaning |\n|---|---|\n| -11 | Missing `X-API-Key` header |\n| -12 | API key is invalid or inactive |\n| -13 | The store's database is unavailable |\n| -21 | Validation failed (the message says which field) |\n| -22 / -23 | `page` or `size` out of range |\n| -24 | Search text too long |\n| -25 / -26 | Invalid id / invalid order number |\n| -27 | Customer email or phone missing |\n| -28 | `from` is later than `to` |\n| -29 | Malformed request body |\n| -30 | Email code wrong or expired |\n| -31 | Not found |\n| -41 | Conflict, e.g. not enough stock or the order can no longer change |\n| -42 | Not configured for this store |\n| -43 | Email not verified |\n| -44 | Store is not live |\n| -45 | Pay on delivery is off |\n| -46 | The delivery company re-priced delivery. Show the shopper the new fee and let them confirm |\n| -47 | Delivery unavailable. The shopper picks another method |\n| -51 | Rate limited. Wait the seconds in the `Retry-After` header, then retry |\n| -99 | Internal error |\n\n## Checkout flow\nA typical checkout calls, in order:\n1. **Catalogue › Browse items** and **Item detail**: show the products.\n2. **Stock › Check cart stock**: confirm the cart can still be filled.\n3. **Address › States** and **Shipping › Shipping quote**: the address form and the delivery fee.\n4. **Payment › Active pay gateway**: which gateway to show.\n5. **Email Verification › Send OTP** and **Verify OTP**: confirm the shopper's email (optional).\n6. **Orders › Create order**: returns the `orderNo`.\n7. **Orders › Pay for order**: send the shopper to `authorizationUrl`.\n8. **Orders › Settle order**: when the shopper comes back, confirm the payment.\n9. **Orders › Order status**: the order-tracking page.\n\n## Paging and limits\n- `page` 1-1000 (default 1) and `size` 1-100 (default 20).\n- Search text `q` up to 200 characters.\n- Orders and stock checks take 1-200 lines.\n- Rate limits, per storefront: 300 requests a minute overall; 20 a minute on stock checks, OTPs, orders and payments; 60 a minute on **POST Shipping quote**. Over the limit answers -51, with a `Retry-After` header giving the seconds to wait.",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://storefrontapi.bizedgehq.com",
      "description": "Production"
    }
  ],
  "security": [
    {
      "ApiKey": []
    }
  ],
  "tags": [
    {
      "name": "Storefront",
      "description": "The storefront's own settings. The company is resolved from the API key, so there is no id to pass."
    },
    {
      "name": "Catalogue",
      "description": "Groups, subgroups, manufacturers and items for the store and branch the API key trades as."
    },
    {
      "name": "Stock",
      "description": "Checks a cart against the store's stock before checkout, so the shopper hears what is short before paying."
    },
    {
      "name": "Address",
      "description": "Reference data behind a checkout form. The same for every storefront."
    },
    {
      "name": "Branch",
      "description": "The company's branches, for a store locator or a pickup-point picker."
    },
    {
      "name": "Shipping",
      "description": "Shipping options for checkout. The shop shows the quote, the shopper picks a method, and the shop posts its id and fee to **Create order**."
    },
    {
      "name": "Payment",
      "description": "How the store takes payment: its pay methods, and the online gateway checkout should drive."
    },
    {
      "name": "Email Verification",
      "description": "Optional email check before checkout: send a code, then verify it."
    },
    {
      "name": "Orders",
      "description": "Create, read, track, pay for, deliver and cancel orders. Send **Create order** first: it saves the new order number to the `orderNo` variable for the requests after it."
    },
    {
      "name": "Paystack",
      "description": "A thin pass-through to Paystack for shops that run their own Paystack checkout. **Neither endpoint touches an order**: to pay for an order, use **Orders › Pay for order** and **Settle order**."
    }
  ],
  "paths": {
    "/v1/storefront/detail": {
      "get": {
        "tags": [
          "Storefront"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StorefrontDetailDtoApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "name": "My Store",
                        "tagline": "...the best or nothing",
                        "contact": {
                          "phone": "8031234567",
                          "email": "shopper@example.com",
                          "whatsApp": null,
                          "website": null
                        },
                        "address": {
                          "address1": "1B, Ogunlowo Street C",
                          "address2": null,
                          "city": "ikeja",
                          "state": "Lagos",
                          "country": "Nigeria"
                        },
                        "social": {
                          "facebook": null,
                          "instagram": null,
                          "twitter": null,
                          "tikTok": null,
                          "linkedIn": null
                        },
                        "branding": {
                          "logo": null,
                          "bannerImage": null,
                          "primaryColor": "#36a59c",
                          "secondaryColor": "#284692",
                          "currencyCode": "NGN",
                          "currencySymbol": "₦",
                          "favicon": null
                        },
                        "businessHours": null,
                        "announcement": "Free delivery on purchases over ₦1M",
                        "seo": {
                          "metaTitle": null,
                          "metaDescription": null,
                          "shareImage": null,
                          "gaId": null,
                          "pixelId": null
                        },
                        "payOnDelivery": true
                      }
                    }
                  },
                  "missing-api-key": {
                    "summary": "Missing API key",
                    "value": {
                      "errorCode": -11,
                      "errorMessage": "Missing X-API-Key header",
                      "data": null
                    }
                  },
                  "invalid-api-key": {
                    "summary": "Invalid API key",
                    "value": {
                      "errorCode": -12,
                      "errorMessage": "API key is invalid or inactive",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Detail",
        "description": "The storefront's public detail: name, contact, address, branding, social links and SEO.",
        "operationId": "storefront-detail"
      }
    },
    "/v1/storefront/about": {
      "get": {
        "tags": [
          "Storefront"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StorefrontAboutDtoApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "about": null
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "About",
        "description": "About-page text. A merchant who has written none gets success with a null field.",
        "operationId": "storefront-about"
      }
    },
    "/v1/storefront/returnpolicy": {
      "get": {
        "tags": [
          "Storefront"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StorefrontReturnPolicyDtoApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "returnPolicy": null
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Return policy",
        "description": "The store's return policy.",
        "operationId": "storefront-return-policy"
      }
    },
    "/v1/storefront/pages": {
      "get": {
        "tags": [
          "Storefront"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HostedPageDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": []
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Pages",
        "description": "Information pages the merchant has written (about, terms, privacy, FAQ, shipping, returns). Pages still holding starter text are left out.",
        "operationId": "storefront-pages"
      }
    },
    "/v1/group": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GroupDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 886,
                          "name": "Alcohol",
                          "description": "Alcohol",
                          "priority": 1
                        },
                        {
                          "id": 903,
                          "name": "Alcoholic Drink",
                          "description": "Alcoholic Drink",
                          "priority": 1
                        },
                        {
                          "id": 1182,
                          "name": "Bath",
                          "description": "bath",
                          "priority": 1
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Groups",
        "description": "All item groups.",
        "operationId": "catalogue-groups"
      }
    },
    "/v1/subgroup": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "parameters": [
          {
            "name": "groupId",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "Optional group filter",
            "example": 654
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubGroupDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 6470,
                          "groupId": 654,
                          "name": "Cocktail",
                          "description": "Cocktail",
                          "priority": 1
                        },
                        {
                          "id": 2654,
                          "groupId": 886,
                          "name": "Whisky",
                          "description": "Whisky",
                          "priority": 1
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Subgroups",
        "description": "Item subgroups, optionally filtered by group.",
        "operationId": "catalogue-subgroups"
      }
    },
    "/v1/subgroup/menu": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SubGroupMenuDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 6470,
                          "groupId": 654,
                          "name": "Cocktail",
                          "description": "Cocktail",
                          "isFeatured": false,
                          "priority": 0
                        },
                        {
                          "id": 2654,
                          "groupId": 886,
                          "name": "Whisky",
                          "description": "Whisky",
                          "isFeatured": false,
                          "priority": 0
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Subgroup menu",
        "description": "The category menu, in the merchant's order, with the featured flag.",
        "operationId": "catalogue-subgroup-menu"
      }
    },
    "/v1/manufacturer": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ManufacturerDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 59,
                          "name": "(One-time Manufacturer)"
                        },
                        {
                          "id": 184,
                          "name": "(One-time Manufacturer)"
                        },
                        {
                          "id": 186,
                          "name": "(One-time Manufacturer)"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Manufacturers",
        "description": "All manufacturers.",
        "operationId": "catalogue-manufacturers"
      }
    },
    "/v1/item": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "parameters": [
          {
            "name": "subgroupId",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "Optional subgroup filter",
            "example": 6470
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Text search, max 200 characters"
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            },
            "description": "1-1000, default 1",
            "example": 1
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            },
            "description": "1-100, default 20",
            "example": 20
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemSummaryDtoPagedResultApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "page": 1,
                        "pageSize": 20,
                        "total": 4,
                        "items": [
                          {
                            "id": 816554,
                            "barcode": "T010209",
                            "name": "33 Larger Beer",
                            "summary": "Purchase of 3 creates of 33 Larger Beer.",
                            "price": 1500,
                            "promoPrice": 1500,
                            "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                            "unit": "Bottle",
                            "availableQuantity": 0,
                            "inStock": false,
                            "taxRate1": 0,
                            "taxRate2": 0,
                            "taxRate3": 0
                          },
                          {
                            "id": 797638,
                            "barcode": "T010100",
                            "name": "5 Alive Pulp",
                            "summary": "Test Summary",
                            "price": 2300,
                            "promoPrice": 2300,
                            "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                            "unit": "Bottle",
                            "availableQuantity": 0,
                            "inStock": false,
                            "taxRate1": 7.5,
                            "taxRate2": 0,
                            "taxRate3": 0
                          },
                          {
                            "id": 816552,
                            "barcode": "00001",
                            "name": "5alive",
                            "summary": "softdrive",
                            "price": 995,
                            "promoPrice": 995,
                            "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                            "unit": "can",
                            "availableQuantity": 0,
                            "inStock": false,
                            "taxRate1": 0,
                            "taxRate2": 0,
                            "taxRate3": 0
                          }
                        ]
                      }
                    }
                  },
                  "page-size-too-large": {
                    "summary": "Page size too large",
                    "value": {
                      "errorCode": -23,
                      "errorMessage": "size must be between 1 and 100",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Search items",
        "description": "Paged item search, optionally filtered by subgroup and a text query (max 200 characters).",
        "operationId": "catalogue-search-items"
      }
    },
    "/v1/item/subgroup/{subgroupId}": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "parameters": [
          {
            "name": "subgroupId",
            "in": "path",
            "required": true,
            "schema": {
              "minimum": 1,
              "type": "integer",
              "format": "int64"
            },
            "example": 6470
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Text search, max 200 characters"
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            },
            "description": "1-1000, default 1",
            "example": 1
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            },
            "description": "1-100, default 20",
            "example": 20
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemSummaryDtoPagedResultApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "page": 1,
                        "pageSize": 20,
                        "total": 0,
                        "items": []
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Items in subgroup",
        "description": "Same as search with the subgroup in the route. An unknown subgroup answers NotFound (-31) rather than an empty page.",
        "operationId": "catalogue-items-in-subgroup"
      }
    },
    "/v1/item/browse": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "parameters": [
          {
            "name": "subgroupId",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "Optional subgroup filter",
            "example": 6470
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Text search, max 200 characters"
          },
          {
            "name": "sort",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "featured | newest | priceasc | pricedesc | name",
            "example": "featured"
          },
          {
            "name": "featured",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "true = featured items only (home page)",
            "example": false
          },
          {
            "name": "inStock",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": false
            },
            "description": "true = leave out sold-out items",
            "example": false
          },
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 1
            },
            "description": "1-1000, default 1",
            "example": 1
          },
          {
            "name": "size",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 20
            },
            "description": "1-100, default 20",
            "example": 20
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemSummaryDtoPagedResultApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "page": 1,
                        "pageSize": 20,
                        "total": 4,
                        "items": [
                          {
                            "id": 816554,
                            "barcode": "T010209",
                            "name": "33 Larger Beer",
                            "summary": "Purchase of 3 creates of 33 Larger Beer.",
                            "price": 1500,
                            "promoPrice": 1500,
                            "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                            "unit": "Bottle",
                            "availableQuantity": 0,
                            "inStock": false,
                            "taxRate1": 0,
                            "taxRate2": 0,
                            "taxRate3": 0
                          },
                          {
                            "id": 797638,
                            "barcode": "T010100",
                            "name": "5 Alive Pulp",
                            "summary": "Test Summary",
                            "price": 2300,
                            "promoPrice": 2300,
                            "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                            "unit": "Bottle",
                            "availableQuantity": 0,
                            "inStock": false,
                            "taxRate1": 7.5,
                            "taxRate2": 0,
                            "taxRate3": 0
                          },
                          {
                            "id": 816552,
                            "barcode": "00001",
                            "name": "5alive",
                            "summary": "softdrive",
                            "price": 995,
                            "promoPrice": 995,
                            "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                            "unit": "can",
                            "availableQuantity": 0,
                            "inStock": false,
                            "taxRate1": 0,
                            "taxRate2": 0,
                            "taxRate3": 0
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Browse items",
        "description": "The shop listing: search plus a sort order, a featured-only filter and an in-stock filter. A store whose database lacks the storefront columns answers NotConfigured (-42).",
        "operationId": "catalogue-browse-items"
      }
    },
    "/v1/item/{id}": {
      "get": {
        "tags": [
          "Catalogue"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "minimum": 1,
              "type": "integer",
              "format": "int64"
            },
            "example": 816554
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ItemDetailDtoApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "id": 816554,
                        "barcode": "T010209",
                        "name": "33 Larger Beer",
                        "summary": "Purchase of 3 creates of 33 Larger Beer.",
                        "description": null,
                        "price": 1500,
                        "promoPrice": 1500,
                        "tierPrices": [
                          1500,
                          0,
                          0
                        ],
                        "imageUrl": "https://bizedgehq.s3.amazonaws.com/itemprofile/defaultitemimage.png",
                        "unit": "Bottle",
                        "brand": "(One-time Manufacturer)",
                        "subGroupId": 6653,
                        "subGroupName": null,
                        "groupId": 654,
                        "groupName": "Beverage",
                        "availableQuantity": 0,
                        "inStock": false,
                        "weight": 0,
                        "dimensions": null,
                        "taxRate1": 0,
                        "taxRate2": 0,
                        "taxRate3": 0,
                        "seoTitle": null,
                        "seoDescription": null
                      }
                    }
                  },
                  "unknown-item": {
                    "summary": "Unknown item",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Item 999999999 not found",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Item detail",
        "description": "One item with its full detail.",
        "operationId": "catalogue-item-detail"
      }
    },
    "/v1/stock/check": {
      "post": {
        "tags": [
          "Stock"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/StockCheckRequest"
              },
              "example": {
                "lines": [
                  {
                    "itemId": 816554,
                    "quantity": 1
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StockCheckResponseApiResponse"
                },
                "examples": {
                  "error-41-1-item-s-unavailable": {
                    "summary": "Error -41: 1 item(s) unavailable",
                    "value": {
                      "errorCode": -41,
                      "errorMessage": "1 item(s) unavailable",
                      "data": {
                        "ok": false,
                        "insufficientItems": [
                          {
                            "itemId": 816554,
                            "name": "33 Larger Beer",
                            "requested": 1,
                            "available": 0,
                            "reason": "InsufficientStock"
                          }
                        ]
                      }
                    }
                  },
                  "not-enough-stock": {
                    "summary": "Not enough stock",
                    "value": {
                      "errorCode": -41,
                      "errorMessage": "1 item(s) unavailable",
                      "data": {
                        "ok": false,
                        "insufficientItems": [
                          {
                            "itemId": 816554,
                            "name": "33 Larger Beer",
                            "requested": 1000000,
                            "available": 0,
                            "reason": "InsufficientStock"
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Check cart stock",
        "description": "Tells the shopper what is short before checkout. Reads and writes nothing. 1-200 lines.\n\nWhen something is short the envelope fails with Conflict (-41) and `data` still carries `insufficientItems`, each with a `reason` of `InsufficientStock` or `NotAvailable` and the quantity `available`, so the shop can offer what is left.",
        "operationId": "stock-check-cart-stock"
      }
    },
    "/v1/address/countries": {
      "get": {
        "tags": [
          "Address"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountryDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 3,
                          "name": "Afghanistan"
                        },
                        {
                          "id": 16,
                          "name": "Aland Islands"
                        },
                        {
                          "id": 6,
                          "name": "Albania"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Countries",
        "description": "All countries.",
        "operationId": "address-countries"
      }
    },
    "/v1/address/countrieswithcurrency": {
      "get": {
        "tags": [
          "Address"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CountryWithCurrencyDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 3,
                          "name": "Afghanistan",
                          "currencyCode": "AFN",
                          "currencySymbol": "?"
                        },
                        {
                          "id": 16,
                          "name": "Aland Islands",
                          "currencyCode": "EUR",
                          "currencySymbol": "€"
                        },
                        {
                          "id": 6,
                          "name": "Albania",
                          "currencyCode": "ALL",
                          "currencySymbol": "Lek"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Countries with currency",
        "description": "Countries with their currency.",
        "operationId": "address-countries-with-currency"
      }
    },
    "/v1/address/dialcodes": {
      "get": {
        "tags": [
          "Address"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DialCodeDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "isoAlpha2": "AF",
                          "name": "Afghanistan",
                          "phoneCode": "93"
                        },
                        {
                          "isoAlpha2": "AX",
                          "name": "Aland Islands",
                          "phoneCode": "358"
                        },
                        {
                          "isoAlpha2": "AL",
                          "name": "Albania",
                          "phoneCode": "355"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Dial codes",
        "description": "Every country with a dial code, for phone-number dropdowns. `phoneCode` is digits only, e.g. `234`.",
        "operationId": "address-dial-codes"
      }
    },
    "/v1/address/states": {
      "get": {
        "tags": [
          "Address"
        ],
        "parameters": [
          {
            "name": "countryId",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "Country id (required)",
            "example": 163
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/StateDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 8,
                          "countryId": 163,
                          "name": "Abia"
                        },
                        {
                          "id": 17,
                          "countryId": 163,
                          "name": "Abuja"
                        },
                        {
                          "id": 18,
                          "countryId": 163,
                          "name": "Adamawa"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "States",
        "description": "States of a country.",
        "operationId": "address-states"
      }
    },
    "/v1/branch/addresses": {
      "get": {
        "tags": [
          "Branch"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BranchAddressDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 1,
                          "name": "Ikeja Obanta Branch",
                          "phone": "8031234567",
                          "email": "shopper@example.com",
                          "address1": "1A  Ogunlowo Street",
                          "address2": "Obanta Avenue",
                          "city": "Ikeja",
                          "state": "Lagos",
                          "country": "Nigeria"
                        },
                        {
                          "id": 378,
                          "name": "Nairobi Branch",
                          "phone": "8031234567",
                          "email": "shopper@example.com",
                          "address1": "G & K Mall",
                          "address2": "",
                          "city": "Nairobi",
                          "state": "Lagos",
                          "country": "Nigeria"
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Branch addresses",
        "description": "All of the company's branches with their addresses.",
        "operationId": "branch-branch-addresses"
      }
    },
    "/v1/shipping/methods": {
      "get": {
        "tags": [
          "Shipping"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingMethodDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 1,
                          "name": "Pickup",
                          "description": "Collect from our store during business hours.",
                          "requiresAddress": false
                        },
                        {
                          "id": 2,
                          "name": "Delivery",
                          "description": "Delivered to your address in 2-5 working days.",
                          "requiresAddress": true
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Shipping methods",
        "description": "The company's active shipping methods.",
        "operationId": "shipping-shipping-methods"
      }
    },
    "/v1/shipping/quote": {
      "get": {
        "tags": [
          "Shipping"
        ],
        "parameters": [
          {
            "name": "stateId",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0
            },
            "description": "Destination state (0 for pickup only)",
            "example": 1
          },
          {
            "name": "total",
            "in": "query",
            "schema": {
              "type": "number",
              "format": "double",
              "default": 0
            },
            "description": "Goods total including tax",
            "example": 25000
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingQuoteDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 1,
                          "name": "Pickup",
                          "description": "Collect from our store during business hours.",
                          "requiresAddress": false,
                          "merchantPriced": false,
                          "fee": null,
                          "providerPriced": false,
                          "available": true,
                          "reason": null
                        },
                        {
                          "id": 2,
                          "name": "Delivery",
                          "description": "Delivered to your address in 2-5 working days.",
                          "requiresAddress": true,
                          "merchantPriced": false,
                          "fee": null,
                          "providerPriced": false,
                          "available": true,
                          "reason": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Shipping quote",
        "description": "Fees for a cart by destination state. Enough for flat-rate and merchant-priced methods; a method a delivery company prices needs **POST Shipping quote**.",
        "operationId": "shipping-shipping-quote"
      },
      "post": {
        "tags": [
          "Shipping"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ShippingQuoteRequest"
              },
              "example": {
                "stateId": 1,
                "address1": "12 Allen Avenue",
                "address2": null,
                "city": "Ikeja",
                "total": 25000,
                "lines": [
                  {
                    "itemId": 816554,
                    "quantity": 1
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShippingQuoteDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 1,
                          "name": "Pickup",
                          "description": "Collect from our store during business hours.",
                          "requiresAddress": false,
                          "merchantPriced": false,
                          "fee": null,
                          "providerPriced": false,
                          "available": true,
                          "reason": null
                        },
                        {
                          "id": 2,
                          "name": "Delivery",
                          "description": "Delivered to your address in 2-5 working days.",
                          "requiresAddress": true,
                          "merchantPriced": false,
                          "fee": null,
                          "providerPriced": false,
                          "available": true,
                          "reason": null
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Shipping quote for address",
        "description": "Fees for a cart with the full delivery address and lines, which methods priced by a delivery company need. A method the company can't serve comes back with `available` false and a `reason`.\n\nRate-limited at 60 a minute, apart from the orders budget, so a shopper editing their address doesn't use up the limit their order needs.",
        "operationId": "shipping-shipping-quote-for-address"
      }
    },
    "/v1/payment/methods": {
      "get": {
        "tags": [
          "Payment"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayMethodDtoIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": [
                        {
                          "id": 1483,
                          "name": "Cash",
                          "payType": 1
                        },
                        {
                          "id": 1268,
                          "name": "Cash",
                          "payType": 1
                        },
                        {
                          "id": 1278,
                          "name": "Cash",
                          "payType": 1
                        }
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Pay methods",
        "description": "Payment methods the company accepts. Send the chosen `id` as `payMethodId` in **Create order**.",
        "operationId": "payment-pay-methods"
      }
    },
    "/v1/paygateway/active": {
      "get": {
        "tags": [
          "Payment"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ActivePayGatewayDtoApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "id": 3,
                        "name": "Paystack",
                        "payMethodId": 3510,
                        "live": false,
                        "publicKey": ""
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Active pay gateway",
        "description": "The active gateway at checkout: which to drive (Paystack or SeerBit), its pay method id, live or test mode, and its public key (never the secret).",
        "operationId": "payment-active-pay-gateway"
      }
    },
    "/v1/emailverification/sendotp": {
      "post": {
        "tags": [
          "Email Verification"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SendOtpRequest"
              },
              "example": {
                "email": "shopper@example.com"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SendOtpResponseApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": {
                        "maskedEmail": "s*****@example.com",
                        "expiresInSeconds": 900,
                        "resendAfterSeconds": 60
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Send OTP",
        "description": "Mails a 6-digit code. Always succeeds with the same shape, so it can't be used to tell which addresses are customers. `resendAfterSeconds` is non-zero when a resend was suppressed: count down from it before offering another.",
        "operationId": "email-verification-send-otp"
      }
    },
    "/v1/emailverification/verifyotp": {
      "post": {
        "tags": [
          "Email Verification"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VerifyOtpRequest"
              },
              "example": {
                "email": "shopper@example.com",
                "otp": "123456"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VerifyOtpResponseApiResponse"
                },
                "examples": {
                  "error-30-code-is-invalid-or-has-expired": {
                    "summary": "Error -30: Code is invalid or has expired",
                    "value": {
                      "errorCode": -30,
                      "errorMessage": "Code is invalid or has expired",
                      "data": null
                    }
                  },
                  "wrong-code": {
                    "summary": "Wrong code",
                    "value": {
                      "errorCode": -30,
                      "errorMessage": "Code is invalid or has expired",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Verify OTP",
        "description": "Checks the code. A wrong, expired or missing code answers EmailCodeInvalid (-30), and `attemptsRemaining` counts down. On success, `verificationToken` is returned once (only its hash is kept) and saved to the `verificationToken` variable.",
        "operationId": "email-verification-verify-otp"
      }
    },
    "/v1/order/add": {
      "post": {
        "tags": [
          "Orders"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateOrderRequest"
              },
              "example": {
                "customer": {
                  "firstName": "Ada",
                  "lastName": "Okafor",
                  "otherName": null,
                  "email": "shopper@example.com",
                  "phone": "8031234567",
                  "phoneCode": "234"
                },
                "shipping": {
                  "fullName": "Ada Okafor",
                  "phone": "8031234567",
                  "email": "shopper@example.com",
                  "address1": "12 Allen Avenue",
                  "address2": null,
                  "city": "Ikeja",
                  "stateId": 1,
                  "postalCode": "100001",
                  "instructions": "Call on arrival",
                  "methodId": 0,
                  "fee": 0
                },
                "lines": [
                  {
                    "itemId": 816554,
                    "quantity": 1
                  }
                ],
                "payMethodId": 3510,
                "gatewayReference": null
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponseApiResponse"
                },
                "examples": {
                  "error-41-insufficient-stock-for-item-816554-available-0-requested-1": {
                    "summary": "Error -41: Insufficient stock for item 816554 (available 0, requested 1)",
                    "value": {
                      "errorCode": -41,
                      "errorMessage": "Insufficient stock for item 816554 (available 0, requested 1)",
                      "data": null
                    }
                  },
                  "empty-cart": {
                    "summary": "Empty cart",
                    "value": {
                      "errorCode": -29,
                      "errorMessage": "Order must contain at least one line",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Create order",
        "description": "Creates an order. 1-200 lines.\n\n- `shipping.methodId` 0 means no method chosen (no fee, address required). Otherwise it must be an active shipping method, and the address fields are required only when that method needs an address.\n- `shipping.fee` is the fee from **Shipping quote** (0 to 10,000,000). For a method a delivery company prices, a different fee answers -46 with the new fee in the message.\n- `customer.phone` is the number without the country code, and `customer.phoneCode` is the country code in digits only, e.g. `234`.\n\nCan fail with ValidationFailed (-21), Conflict (-41, e.g. not enough stock), StoreNotLive (-44), PayOnDeliveryOff (-45), ShippingQuoteChanged (-46) or DeliveryUnavailable (-47).\n\nOrder numbers look like `SO261120B001C0001`: `SO`, the date (YYMMDD), the branch and a counter.",
        "operationId": "orders-create-order"
      }
    },
    "/v1/order/{orderNo}": {
      "get": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "orderNo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SO261120B001C0001"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponseApiResponse"
                },
                "examples": {
                  "error-31-order-so261120b001c0001-not-found": {
                    "summary": "Error -31: Order SO261120B001C0001 not found",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Order SO261120B001C0001 not found",
                      "data": null
                    }
                  },
                  "unknown-order": {
                    "summary": "Unknown order",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Order SO000000B000C0000 not found",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Get order",
        "description": "One order with its lines, customer and shipping.",
        "operationId": "orders-get-order"
      },
      "delete": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "orderNo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SO261120B001C0001"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiResponse"
                },
                "examples": {
                  "error-31-no-pending-order-so261120b001c0001-to-cancel": {
                    "summary": "Error -31: No pending order SO261120B001C0001 to cancel",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "No pending order SO261120B001C0001 to cancel",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Cancel order",
        "description": "Cancels a pending (stage 0) order. A missing or already-sold order answers NotFound (-31).",
        "operationId": "orders-cancel-order"
      }
    },
    "/v1/order/{orderNo}/status": {
      "get": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "orderNo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SO261120B001C0001"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderStatusDtoApiResponse"
                },
                "examples": {
                  "error-31-order-so261120b001c0001-not-found": {
                    "summary": "Error -31: Order SO261120B001C0001 not found",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Order SO261120B001C0001 not found",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Order status",
        "description": "Order tracking: the order's stage, payment status and delivery booking. `email` and `phone` are returned so the shop can check the shopper's identity before showing anything.",
        "operationId": "orders-order-status"
      }
    },
    "/v1/order/bycustomer": {
      "get": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "customer",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Email or phone (required)",
            "example": "shopper@example.com"
          },
          {
            "name": "from",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "description": "Optional start date",
            "example": "2026-01-01"
          },
          {
            "name": "to",
            "in": "query",
            "schema": {
              "type": "string",
              "format": "date-time"
            },
            "description": "Optional end date",
            "example": "2026-12-31"
          },
          {
            "name": "stage",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "Optional stage filter (0 = pending)",
            "example": 0
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OrderResponseIReadOnlyListApiResponse"
                },
                "examples": {
                  "success": {
                    "summary": "Success",
                    "value": {
                      "errorCode": 0,
                      "errorMessage": "",
                      "data": []
                    }
                  },
                  "dates-reversed": {
                    "summary": "Dates reversed",
                    "value": {
                      "errorCode": -28,
                      "errorMessage": "from must not be later than to",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Orders by customer",
        "description": "A customer's orders, by email or phone. `from` must not be later than `to`.",
        "operationId": "orders-orders-by-customer"
      }
    },
    "/v1/order/{orderNo}/pay": {
      "post": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "orderNo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SO261120B001C0001"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayOrderRequest"
              },
              "example": {
                "callbackUrl": "https://shop.example.com/checkout/complete"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PayOrderResponseApiResponse"
                },
                "examples": {
                  "error-31-order-so261120b001c0001-not-found": {
                    "summary": "Error -31: Order SO261120B001C0001 not found",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Order SO261120B001C0001 not found",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Pay for order",
        "description": "Opens a transaction with the store's active gateway (Paystack or SeerBit) for the order's own total, and returns `authorizationUrl` to send the shopper to. Saves `reference` to the `paymentReference` variable.",
        "operationId": "orders-pay-for-order"
      }
    },
    "/v1/order/{orderNo}/settle": {
      "post": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "orderNo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SO261120B001C0001"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SettleOrderRequest"
              },
              "example": {
                "reference": "T284716395028174"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SettleOrderResponseApiResponse"
                },
                "examples": {
                  "error-31-order-so261120b001c0001-not-found": {
                    "summary": "Error -31: Order SO261120B001C0001 not found",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Order SO261120B001C0001 not found",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Settle order",
        "description": "Verifies the reference with the gateway that issued it and, if it paid this order in full, marks the payment verified. Not paid is a success with `paid` false.",
        "operationId": "orders-settle-order"
      }
    },
    "/v1/order/{orderNo}/delivery/book": {
      "post": {
        "tags": [
          "Orders"
        ],
        "parameters": [
          {
            "name": "orderNo",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "SO261120B001C0001"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/BookDeliveryRequest"
              },
              "example": {
                "pickupDate": null,
                "pickupWindow": null
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/BookDeliveryResponseApiResponse"
                },
                "examples": {
                  "error-31-order-not-found": {
                    "summary": "Error -31: Order not found",
                    "value": {
                      "errorCode": -31,
                      "errorMessage": "Order not found",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Book delivery",
        "description": "Books the order's delivery with the store's delivery company (e.g. Dellyman). Not needed when the store books automatically.\n\nBoth body fields are optional: `pickupDate` (yyyy-MM-dd, in the store's time zone) and `pickupWindow` default to the next pickup in the merchant's window. Fails with NotFound (-31), NotConfigured (-42), Conflict (-41) or DeliveryUnavailable (-47).",
        "operationId": "orders-book-delivery"
      }
    },
    "/v1/paystack/initialize": {
      "post": {
        "tags": [
          "Paystack"
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/InitializePaymentRequest"
              },
              "example": {
                "email": "shopper@example.com",
                "amountInKobo": 500000
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InitializePaymentResponseApiResponse"
                },
                "examples": {
                  "error-42-payment-gateway-rejected-the-request-http-401": {
                    "summary": "Error -42: Payment gateway rejected the request (HTTP 401)",
                    "value": {
                      "errorCode": -42,
                      "errorMessage": "Payment gateway rejected the request (HTTP 401)",
                      "data": null
                    }
                  }
                }
              }
            }
          }
        },
        "summary": "Initialize payment",
        "description": "Opens a Paystack transaction for an amount in kobo (100 kobo = 1 naira). Saves `reference` to the `paymentReference` variable.",
        "operationId": "paystack-initialize-payment"
      }
    },
    "/v1/paystack/verify": {
      "get": {
        "tags": [
          "Paystack"
        ],
        "parameters": [
          {
            "name": "reference",
            "in": "query",
            "schema": {
              "type": "string"
            },
            "description": "Paystack reference (required)",
            "example": "T284716395028174"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VerifyPaymentResponseApiResponse"
                }
              }
            }
          }
        },
        "summary": "Verify payment",
        "description": "What Paystack reports for a reference.",
        "operationId": "paystack-verify-payment"
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "description": "Storefront API key issued during provisioning.",
        "name": "X-API-Key",
        "in": "header"
      }
    },
    "schemas": {
      "StorefrontDetailDtoApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/StorefrontDetailDto"
          }
        },
        "additionalProperties": false
      },
      "StorefrontDetailDto": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "nullable": true
          },
          "tagline": {
            "type": "string",
            "nullable": true
          },
          "contact": {
            "$ref": "#/components/schemas/StorefrontContactDto"
          },
          "address": {
            "$ref": "#/components/schemas/CompanyAddressDto"
          },
          "social": {
            "$ref": "#/components/schemas/StorefrontSocialDto"
          },
          "branding": {
            "$ref": "#/components/schemas/StorefrontBrandingDto"
          },
          "businessHours": {
            "type": "string",
            "nullable": true
          },
          "announcement": {
            "type": "string",
            "nullable": true
          },
          "seo": {
            "$ref": "#/components/schemas/StorefrontSeoDto"
          },
          "payOnDelivery": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "StorefrontContactDto": {
        "type": "object",
        "properties": {
          "phone": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "whatsApp": {
            "type": "string",
            "nullable": true
          },
          "website": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CompanyAddressDto": {
        "type": "object",
        "properties": {
          "address1": {
            "type": "string",
            "nullable": true
          },
          "address2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StorefrontSocialDto": {
        "type": "object",
        "properties": {
          "facebook": {
            "type": "string",
            "nullable": true
          },
          "instagram": {
            "type": "string",
            "nullable": true
          },
          "twitter": {
            "type": "string",
            "nullable": true
          },
          "tikTok": {
            "type": "string",
            "nullable": true
          },
          "linkedIn": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StorefrontBrandingDto": {
        "type": "object",
        "properties": {
          "logo": {
            "type": "string",
            "nullable": true
          },
          "bannerImage": {
            "type": "string",
            "nullable": true
          },
          "primaryColor": {
            "type": "string",
            "nullable": true
          },
          "secondaryColor": {
            "type": "string",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "currencySymbol": {
            "type": "string",
            "nullable": true
          },
          "favicon": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StorefrontSeoDto": {
        "type": "object",
        "properties": {
          "metaTitle": {
            "type": "string",
            "nullable": true
          },
          "metaDescription": {
            "type": "string",
            "nullable": true
          },
          "shareImage": {
            "type": "string",
            "nullable": true
          },
          "gaId": {
            "type": "string",
            "nullable": true
          },
          "pixelId": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StorefrontAboutDtoApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/StorefrontAboutDto"
          }
        },
        "additionalProperties": false
      },
      "StorefrontAboutDto": {
        "type": "object",
        "properties": {
          "about": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StorefrontReturnPolicyDtoApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/StorefrontReturnPolicyDto"
          }
        },
        "additionalProperties": false
      },
      "StorefrontReturnPolicyDto": {
        "type": "object",
        "properties": {
          "returnPolicy": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HostedPageDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HostedPageDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HostedPageDto": {
        "type": "object",
        "properties": {
          "contentId": {
            "type": "integer",
            "format": "int32"
          },
          "contentType": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "content": {
            "type": "string",
            "nullable": true
          },
          "isCustomised": {
            "type": "boolean"
          },
          "questions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HostedFaqDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "HostedFaqDto": {
        "type": "object",
        "properties": {
          "question": {
            "type": "string",
            "nullable": true
          },
          "answer": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "GroupDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/GroupDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "GroupDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "priority": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "SubGroupDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubGroupDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SubGroupDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "groupId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "priority": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "SubGroupMenuDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SubGroupMenuDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SubGroupMenuDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "groupId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "isFeatured": {
            "type": "boolean"
          },
          "priority": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "ManufacturerDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ManufacturerDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ManufacturerDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ItemSummaryDtoPagedResultApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/ItemSummaryDtoPagedResult"
          }
        },
        "additionalProperties": false
      },
      "ItemSummaryDtoPagedResult": {
        "type": "object",
        "properties": {
          "page": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "total": {
            "type": "integer",
            "format": "int64"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ItemSummaryDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ItemSummaryDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "barcode": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "summary": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "format": "double"
          },
          "promoPrice": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "imageUrl": {
            "type": "string",
            "nullable": true
          },
          "unit": {
            "type": "string",
            "nullable": true
          },
          "availableQuantity": {
            "type": "number",
            "format": "double"
          },
          "inStock": {
            "type": "boolean"
          },
          "taxRate1": {
            "type": "number",
            "format": "double"
          },
          "taxRate2": {
            "type": "number",
            "format": "double"
          },
          "taxRate3": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "ItemDetailDtoApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/ItemDetailDto"
          }
        },
        "additionalProperties": false
      },
      "ItemDetailDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "barcode": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "summary": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "price": {
            "type": "number",
            "format": "double"
          },
          "promoPrice": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "tierPrices": {
            "type": "array",
            "items": {
              "type": "number",
              "format": "double"
            },
            "nullable": true
          },
          "imageUrl": {
            "type": "string",
            "nullable": true
          },
          "unit": {
            "type": "string",
            "nullable": true
          },
          "brand": {
            "type": "string",
            "nullable": true
          },
          "subGroupId": {
            "type": "integer",
            "format": "int32"
          },
          "subGroupName": {
            "type": "string",
            "nullable": true
          },
          "groupId": {
            "type": "integer",
            "format": "int32"
          },
          "groupName": {
            "type": "string",
            "nullable": true
          },
          "availableQuantity": {
            "type": "number",
            "format": "double"
          },
          "inStock": {
            "type": "boolean"
          },
          "weight": {
            "type": "number",
            "format": "double"
          },
          "dimensions": {
            "$ref": "#/components/schemas/ItemDimensionsDto"
          },
          "taxRate1": {
            "type": "number",
            "format": "double"
          },
          "taxRate2": {
            "type": "number",
            "format": "double"
          },
          "taxRate3": {
            "type": "number",
            "format": "double"
          },
          "seoTitle": {
            "type": "string",
            "nullable": true
          },
          "seoDescription": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ItemDimensionsDto": {
        "type": "object",
        "properties": {
          "length": {
            "type": "number",
            "format": "double"
          },
          "width": {
            "type": "number",
            "format": "double"
          },
          "height": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "StockCheckRequest": {
        "type": "object",
        "properties": {
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StockCheckLineRequest"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StockCheckLineRequest": {
        "type": "object",
        "properties": {
          "itemId": {
            "type": "integer",
            "format": "int32"
          },
          "quantity": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "StockCheckResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/StockCheckResponse"
          }
        },
        "additionalProperties": false
      },
      "StockCheckResponse": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "insufficientItems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InsufficientItemDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "InsufficientItemDto": {
        "type": "object",
        "properties": {
          "itemId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "requested": {
            "type": "number",
            "format": "double"
          },
          "available": {
            "type": "number",
            "format": "double"
          },
          "reason": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CountryDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CountryDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CountryDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CountryWithCurrencyDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CountryWithCurrencyDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "CountryWithCurrencyDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "currencyCode": {
            "type": "string",
            "nullable": true
          },
          "currencySymbol": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DialCodeDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/DialCodeDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "DialCodeDto": {
        "type": "object",
        "properties": {
          "isoAlpha2": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "phoneCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StateDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StateDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "StateDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "countryId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BranchAddressDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/BranchAddressDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BranchAddressDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "address1": {
            "type": "string",
            "nullable": true
          },
          "address2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "state": {
            "type": "string",
            "nullable": true
          },
          "country": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ShippingMethodDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingMethodDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ShippingMethodDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "requiresAddress": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      },
      "ShippingQuoteDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ShippingQuoteDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ShippingQuoteDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "requiresAddress": {
            "type": "boolean"
          },
          "merchantPriced": {
            "type": "boolean"
          },
          "fee": {
            "type": "number",
            "format": "double",
            "nullable": true
          },
          "providerPriced": {
            "type": "boolean"
          },
          "available": {
            "type": "boolean"
          },
          "reason": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ShippingQuoteRequest": {
        "type": "object",
        "properties": {
          "stateId": {
            "type": "integer",
            "format": "int32"
          },
          "address1": {
            "type": "string",
            "nullable": true
          },
          "address2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "total": {
            "type": "number",
            "format": "double"
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderLineRequest"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OrderLineRequest": {
        "type": "object",
        "properties": {
          "itemId": {
            "type": "integer",
            "format": "int32"
          },
          "quantity": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "PayMethodDtoIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PayMethodDto"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PayMethodDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "payType": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "ActivePayGatewayDtoApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/ActivePayGatewayDto"
          }
        },
        "additionalProperties": false
      },
      "ActivePayGatewayDto": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "payMethodId": {
            "type": "integer",
            "format": "int32"
          },
          "live": {
            "type": "boolean"
          },
          "publicKey": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SendOtpRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SendOtpResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/SendOtpResponse"
          }
        },
        "additionalProperties": false
      },
      "SendOtpResponse": {
        "type": "object",
        "properties": {
          "maskedEmail": {
            "type": "string",
            "nullable": true
          },
          "expiresInSeconds": {
            "type": "integer",
            "format": "int32"
          },
          "resendAfterSeconds": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "VerifyOtpRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "nullable": true
          },
          "otp": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "VerifyOtpResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/VerifyOtpResponse"
          }
        },
        "additionalProperties": false
      },
      "VerifyOtpResponse": {
        "type": "object",
        "properties": {
          "verified": {
            "type": "boolean"
          },
          "verificationToken": {
            "type": "string",
            "nullable": true
          },
          "attemptsRemaining": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "CreateOrderRequest": {
        "type": "object",
        "properties": {
          "customer": {
            "$ref": "#/components/schemas/OrderCustomerRequest"
          },
          "shipping": {
            "$ref": "#/components/schemas/OrderShippingRequest"
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderLineRequest"
            },
            "nullable": true
          },
          "payMethodId": {
            "type": "integer",
            "format": "int32"
          },
          "gatewayReference": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OrderCustomerRequest": {
        "type": "object",
        "properties": {
          "firstName": {
            "type": "string",
            "nullable": true
          },
          "lastName": {
            "type": "string",
            "nullable": true
          },
          "otherName": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "phoneCode": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OrderShippingRequest": {
        "type": "object",
        "properties": {
          "fullName": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "address1": {
            "type": "string",
            "nullable": true
          },
          "address2": {
            "type": "string",
            "nullable": true
          },
          "city": {
            "type": "string",
            "nullable": true
          },
          "stateId": {
            "type": "integer",
            "format": "int32"
          },
          "postalCode": {
            "type": "string",
            "nullable": true
          },
          "instructions": {
            "type": "string",
            "nullable": true
          },
          "methodId": {
            "type": "integer",
            "format": "int32"
          },
          "fee": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "OrderResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/OrderResponse"
          }
        },
        "additionalProperties": false
      },
      "OrderResponse": {
        "type": "object",
        "properties": {
          "orderNo": {
            "type": "string",
            "nullable": true
          },
          "transDate": {
            "type": "string",
            "format": "date-time"
          },
          "stage": {
            "type": "integer",
            "format": "int32"
          },
          "stageLabel": {
            "type": "string",
            "nullable": true
          },
          "subtotal": {
            "type": "number",
            "format": "double"
          },
          "discount": {
            "type": "number",
            "format": "double"
          },
          "tax": {
            "type": "number",
            "format": "double"
          },
          "shippingFee": {
            "type": "number",
            "format": "double"
          },
          "shippingMethod": {
            "type": "string",
            "nullable": true
          },
          "total": {
            "type": "number",
            "format": "double"
          },
          "shipping": {
            "$ref": "#/components/schemas/OrderShippingRequest"
          },
          "customer": {
            "$ref": "#/components/schemas/OrderCustomerRequest"
          },
          "lines": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderLineResponse"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OrderLineResponse": {
        "type": "object",
        "properties": {
          "itemId": {
            "type": "integer",
            "format": "int32"
          },
          "name": {
            "type": "string",
            "nullable": true
          },
          "quantity": {
            "type": "number",
            "format": "double"
          },
          "sPrice": {
            "type": "number",
            "format": "double"
          },
          "lineDisc": {
            "type": "number",
            "format": "double"
          },
          "tax1": {
            "type": "number",
            "format": "double"
          },
          "tax2": {
            "type": "number",
            "format": "double"
          },
          "tax3": {
            "type": "number",
            "format": "double"
          },
          "lineTotal": {
            "type": "number",
            "format": "double"
          }
        },
        "additionalProperties": false
      },
      "ApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "OrderStatusDtoApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/OrderStatusDto"
          }
        },
        "additionalProperties": false
      },
      "OrderStatusDto": {
        "type": "object",
        "properties": {
          "orderNo": {
            "type": "string",
            "nullable": true
          },
          "transDate": {
            "type": "string",
            "format": "date-time"
          },
          "stage": {
            "type": "integer",
            "format": "int32"
          },
          "cancelled": {
            "type": "boolean"
          },
          "fulfilmentStatus": {
            "type": "integer",
            "format": "int32"
          },
          "carrier": {
            "type": "string",
            "nullable": true
          },
          "trackingNo": {
            "type": "string",
            "nullable": true
          },
          "paymentStatus": {
            "type": "string",
            "nullable": true
          },
          "email": {
            "type": "string",
            "nullable": true
          },
          "phone": {
            "type": "string",
            "nullable": true
          },
          "provider": {
            "type": "string",
            "nullable": true
          },
          "providerStatus": {
            "type": "string",
            "nullable": true
          },
          "bookingStatus": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "OrderResponseIReadOnlyListApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderResponse"
            },
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PayOrderRequest": {
        "type": "object",
        "properties": {
          "callbackUrl": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "PayOrderResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/PayOrderResponse"
          }
        },
        "additionalProperties": false
      },
      "PayOrderResponse": {
        "type": "object",
        "properties": {
          "authorizationUrl": {
            "type": "string",
            "nullable": true
          },
          "reference": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "currency": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SettleOrderRequest": {
        "type": "object",
        "properties": {
          "reference": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SettleOrderResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/SettleOrderResponse"
          }
        },
        "additionalProperties": false
      },
      "SettleOrderResponse": {
        "type": "object",
        "properties": {
          "orderNo": {
            "type": "string",
            "nullable": true
          },
          "paid": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BookDeliveryRequest": {
        "type": "object",
        "properties": {
          "pickupDate": {
            "type": "string",
            "format": "date",
            "nullable": true
          },
          "pickupWindow": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "BookDeliveryResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/BookDeliveryResponse"
          }
        },
        "additionalProperties": false
      },
      "BookDeliveryResponse": {
        "type": "object",
        "properties": {
          "orderNo": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "provider": {
            "type": "string",
            "nullable": true
          },
          "trackingId": {
            "type": "string",
            "nullable": true
          },
          "message": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "InitializePaymentRequest": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "nullable": true
          },
          "amountInKobo": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      },
      "InitializePaymentResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/InitializePaymentResponse"
          }
        },
        "additionalProperties": false
      },
      "InitializePaymentResponse": {
        "type": "object",
        "properties": {
          "authorizationUrl": {
            "type": "string",
            "nullable": true
          },
          "accessCode": {
            "type": "string",
            "nullable": true
          },
          "reference": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "currency": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "VerifyPaymentResponseApiResponse": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "integer",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "nullable": true
          },
          "data": {
            "$ref": "#/components/schemas/VerifyPaymentResponse"
          }
        },
        "additionalProperties": false
      },
      "VerifyPaymentResponse": {
        "type": "object",
        "properties": {
          "reference": {
            "type": "string",
            "nullable": true
          },
          "paid": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "format": "double"
          },
          "currency": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      }
    }
  }
}
