shop-20260101
    shop-20260101
    • Open Api
      • Category
        • Get all categories
      • Product
        • Get product IDs
        • Get products
      • Order
        • Create order
        • Get order list
        • Refresh order
        • Checkout order
        • Pay order
        • Cancel order
      • Address
        • Retrieve recipient address list
        • Query postcode and suburb
        • Edit recipient address
      • Clearance
        • Check clearance info
        • Update personal clearance info
        • Update company clearance info
        • Update passport clearance info
      • Express
        • Preview express
        • Create express
        • Express tracking
        • Query express number
    • Schemas
      • Open Api
        • Vo
          • Category
            • OpenCategoryVo
            • OpenCategoryPageVo
          • Product
            • OpenProductNumberVo
            • OpenProductNumberResultVo
            • OpenProductVo
            • OpenSaleInfoVo
            • OpenPriceRange
            • OpenSkuVo
            • OpenSkuAttrVo
          • Order
            • OpenOrderCreateSuccessVo
            • OpenOrderListVo
            • OpenOrderResultVo
            • OpenOrderCreateFailureVo
            • OpenOrderRefreshVo0
            • OpenOrderRefreshVo1
            • OpenOrderRefreshVo2
            • OpenRiskOrderVo
            • OpenOrderdetailVo
            • OpenOrderCheckoutVo
            • OpenSkuDetailVo
          • Clearance
            • OpenClearanceVo
            • OpenClearancePersonalVo
            • OpenClearanceCompanyVo
            • OpenClearancePassportVo
          • Address
            • OpenAddressVo
            • OpenReceiveAddressVo
          • Express
            • OpenExpressCreateNumberVo
            • OpenExpressDeliveryVo
            • OpenExpressDeliveryModeVo
            • OpenExpressCreateResultVo
            • OpenExpressDeclarednameVo
            • OpenExpressRecordResultVo
            • OpenExpressRecordVo
            • OpenQueryExpressnumberVo
        • Ao
          • Order
            • OpenSkudataAo
            • OpenOrderAo
          • Address
            • OpenReceiveAddressAo
          • Clearance
            • OpenClearancePersonalAo
            • OpenClearanceCompanyAo
            • OpenClearancePassportAo
          • Express
            • OpenExpressPreviewAo
            • OpenExpressCreateAo
            • OpenExpressShipAo
            • OpenQueryExpressnumberAo
            • OpenDeclareAo
        • AjaxMsgOpen

    Developer Guide

    Introduction#

    The open API of GeckoDistribution provides basic operations such as searching for products, paying orders, and initiating package shipments.
    Unless otherwise specified, the monetary units mentioned in the documentation are assumed to be in Rand.

    Quick Start#

    Create a Gecko account#

    GeckoDistribution

    Obtain API access key#

    Contact Gecko support to obtain shop_openapi_token and shop_openapi_version.
    Then, set shop_openapi_token and shop_openapi_version in the API documentation.

    Step1#

    image.png

    Step 2#

    image.png

    Step 3#

    image.png

    Now, you can use these API#

    Version Migration Guide#

    20221020
    20221020 --> 20250310
    Modified at 2025-12-12 00:10:40
    Next
    Get all categories
    Built with