Mbogapi

api

• v1

  • • swap_horiz /api/v1/exports/

      GET OPTIONS

      List Exports

      Copy to clipboard Copy Link

      Open Link  

      ---

      • Description
      • Authentication
      • Permissions
      • Filters

      No description provided by developer

      Action is allowed if any of these auth types is provided(logic OR)

      Type	Description
      OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
      SessionAuthentication	Use Django's session framework for authentication.

      Action is allowed when all of conditions are satisfied(logic AND)

      Type	Description
      IsAuthenticated	Allows access only to authenticated users.

      Param name	Description
      created	Created
      modified	Modified
      name	Name
      custom_report_name	Custom Report Name
      title	Title
      description	Description
      status	Status
      rows_count	Rows Count
      exported_rows_count	Exported Rows Count
      args	Args
      type	Type
      start_time	Start Time
      end_time	End Time
      user	User
      errors	Errors
      is_custom	Is Custom
      start_date	Start Date
      end_date	End Date
      list_size	List Size

      
      

      Request Fields:

      No input data specified

      
      

      Response Fields:

      {

      • id: IntegerField,
      • status_display: CharField,
      • completed_percentage: ReadOnlyField,
      • rows_count: MyCustomSerializerField,
      • exported_rows_count: MyCustomSerializerField,
      • duration: ReadOnlyField,
      • created: DateTimeField,
      • modified: DateTimeField,
      • name: CharField,
      • custom_report_name: CharField,
      • title: CharField,
      • description: CharField,
      • status: ChoiceField,
        Choices

        Value	Meaning
        Q	Queued
        E	Exporting...
        P	Preparing Download...
        F	Failed
        D	Click To Download

      • args: CharField,
      • type: ChoiceField,
        Choices

        Value	Meaning
        C	CSV
        P	PDF

      • file: FileField,
      • start_time: DateTimeField,
      • end_time: DateTimeField,
      • errors: CharField,
      • is_custom: BooleanField,
      • start_date: DateField,
      • end_date: DateField,
      • list_size: ChoiceField,
        Choices

        Value	Meaning
        5	5
        10	10
        20	20
        50	50
        100	100
        300	300
        500	500
        800	800
        1000	1000
        10000	10000

      • user: PrimaryKeyRelatedField Help Text

      }

  • users

    • • swap_horiz /api/v1/users/

        GET POST OPTIONS

        List Create Clients

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Signup response includes an access token

        
        

        {
   "profile":{response fields below},
   "token":{..}
 }

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsSuperAdminOrPOSTOnly	The request is authenticated as a user, or is a read-only request.

        Param name	Description
        last_login	Last Login
        is_superuser	Is Superuser
        groups	Groups
        user_permissions	User Permissions
        username	Username
        first_name	First Name
        last_name	Last Name
        is_staff	Is Staff
        is_active	Is Active
        date_joined	Date Joined
        last_activity	Last Activity
        role	Role
        phone	Phone
        google_profile_image	Google Profile Image
        confirm_code	Confirm Code
        reset_code	Reset Code
        old_password	Old Password
        changed_password	Changed Password
        verified	Verified
        dummy	Dummy
        available	Available
        email	Email
        dob	Dob
        gender	Gender
        allow_messages_import	Allow Messages Import
        filter_args	Filter Args
        password	Password

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • password: CharField Required

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField,

        }
    • • swap_horiz /api/v1/users/me/

        GET PUT PATCH OPTIONS

        Retrieve Update Client

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • password: CharField Required

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField,

        }
    • • swap_horiz /api/v1/users/technicians/

        GET OPTIONS

        List Technicians

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.
        IsSafariNjemaCustomerCareOrAdmin	A base class from which all permission classes should inherit.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField,

        }
    • • swap_horiz /api/v1/users/me/profile/

        GET PUT PATCH OPTIONS

        Retrieve Client

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • email: EmailField, Required
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • password: CharField Required

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • profile_image: SerializerMethodField,
        • full_name: CharField,
        • last_login: DateTimeField,
        • username: CharField, Help Text
        • first_name: CharField,
        • last_name: CharField,
        • date_joined: DateTimeField,
        • role: ChoiceField,
          Choices

          Value	Meaning
          N	Normal
          A	Admin
          C	Customer Care
          T	Technician

        • phone: CharField,
        • google_profile_image: URLField,
        • verified: BooleanField,
        • dummy: BooleanField,
        • available: BooleanField,
        • email: EmailField,
        • dob: DateField,
        • gender: ChoiceField,
          Choices

          Value	Meaning
          M	Male
          F	Female
          RNS	Rather Not Say

        • allow_messages_import: BooleanField,
        • filter_args: CharField,

        }
    • • swap_horiz /api/v1/users/forgot-password

        POST OPTIONS

        Clients Forgot Password

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

    • • swap_horiz /api/v1/users/reset-password

        POST PUT PATCH OPTIONS

        Clients Reset Password

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • reset_code: IntegerField, Required
        • new_password: CharField Required

        }

        
        

        Response Fields:

        {

        • reset_code: IntegerField,
        • new_password: CharField

        }
    • • swap_horiz /api/v1/users/google-signin

        POST OPTIONS

        Google Login

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • token: CharField, Required
        • device_id: CharField

        }

        
        

        Response Fields:

        {

        • token: CharField,
        • device_id: CharField

        }
    • • swap_horiz /api/v1/users/apple-signin

        POST OPTIONS

        Apple Login

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

  • translation-locales

    • • swap_horiz /api/v1/translation-locales/

        GET POST OPTIONS

        List Create Translation Locales

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        country_code	Country Code
        language_code	Language Code
        version	Version
        active	Active

        
        

        Request Fields:

        {

        • name: CharField, Required
        • country_code: CharField, Required
        • language_code: CharField, Required
        • translations: JSONField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • country_code: CharField,
        • language_code: CharField,
        • translations: JSONField,
        • version: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/translation-locales/flutter/

        GET OPTIONS

        List Flutter Formatted Translation Locales

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        DjangoModelPermissionsOrAnonReadOnly	Similar to DjangoModelPermissions, except that anonymous users are allowed read-only access.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        country_code	Country Code
        language_code	Language Code
        version	Version
        active	Active

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • country_code: CharField,
        • language_code: CharField,
        • translations: JSONField,
        • version: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/translation-locales/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Translation Locale

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • country_code: CharField, Required
        • language_code: CharField, Required
        • translations: JSONField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • country_code: CharField,
        • language_code: CharField,
        • translations: JSONField,
        • version: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • translation-texts

    • • swap_horiz /api/v1/translation-texts/

        GET POST OPTIONS

        List Create Translation Texts

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        title	Title
        description	Description
        active	Active

        
        

        Request Fields:

        {

        • title: CharField, Required
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • title: CharField,
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/translation-texts/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Translation Text

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • title: CharField, Required
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • title: CharField,
        • example: JSONField,
        • description: CharField,
        • active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • locale-translation-texts

    • • swap_horiz /api/v1/locale-translation-texts/

        GET POST OPTIONS

        List Create Locale Translation Texts

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        locale	Locale
        text	Text
        translated_text	Translated Text
        not_translated	Not Translated
        original	Original

        
        

        Request Fields:

        {

        • translated_text: CharField,
        • locale: PrimaryKeyRelatedField, Required Help Text
        • text: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • translated_text: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • locale: PrimaryKeyRelatedField, Help Text
        • text: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/locale-translation-texts/stats/<str:type>/

        GET OPTIONS

        List Dynamic Locale Translation Texts Statistics

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        `type` = {stat_types}
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        locale	Locale
        text	Text
        translated_text	Translated Text
        not_translated	Not Translated
        original	Original

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • language: ReadOnlyField,
        • country_code: ReadOnlyField,
        • language_code: ReadOnlyField,
        • original: ReadOnlyField,
        • original_description: ReadOnlyField,
        • translated: ReadOnlyField,
        • is_translated: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • translated_text: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • locale: PrimaryKeyRelatedField, Help Text
        • text: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/locale-translation-texts/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Locale Translation Text

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • translated_text: CharField,
        • locale: PrimaryKeyRelatedField, Required Help Text
        • text: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • translated_text: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • locale: PrimaryKeyRelatedField, Help Text
        • text: PrimaryKeyRelatedField Help Text

        }

  • subscription-plans

    • • swap_horiz /api/v1/subscription-plans/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Subscription Plan

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • amount: FloatField, Required
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField, Required
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • amount: FloatField,
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField,
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscription-plans/

        GET POST OPTIONS

        List Create Subscription Plans

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        description	Description
        amount	Amount
        discount	Discount
        hidden	Hidden
        interval	Interval

        
        

        Request Fields:

        {

        • name: CharField, Required
        • description: CharField,
        • amount: FloatField, Required
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField, Required
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • amount: FloatField,
        • discount: FloatField,
        • hidden: BooleanField,
        • interval: ChoiceField,
          Choices

          Value	Meaning
          weekly	Weekly
          monthly	Monthly

        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • subscriptions

    • • swap_horiz /api/v1/subscriptions/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Subscription

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • customer: PrimaryKeyRelatedField, Required Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_name: ReadOnlyField,
        • plan_id: ReadOnlyField,
        • payment_id: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_amount_paid: ReadOnlyField,
        • plan_latest_transaction_date: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • start_date: DateTimeField,
        • next_payment_date: DateTimeField,
        • is_active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField, Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/me/mpesa-payments/

        GET POST OPTIONS

        List Create Subscription Mpesa Payments

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        reference_number	Reference Number
        payment_for	Payment For
        phone_number	Phone Number
        phone_number_hash	Phone Number Hash
        phone_number_paid	Phone Number Paid
        phone_number_paid_hash	Phone Number Paid Hash
        transaction_id	Transaction Id
        amount	Amount
        amount_paid	Amount Paid
        transaction_date	Transaction Date
        request_trans_time	Request Trans Time
        initiated	Initiated
        completed	Completed
        request_code	Request Code
        request_description	Request Description
        result_code	Result Code
        result_description	Result Description
        subscription	Subscription
        plan	Plan
        plan_quantity	Plan Quantity
        purchase	Purchase
        transaction_type	Transaction Type
        stk_triggered	Stk Triggered
        status	Status
        checkout_request_id	Checkout Request Id
        first_name	First Name
        middle_name	Middle Name
        last_name	Last Name
        trans_time	Trans Time
        confirmed	Confirmed

        
        

        Request Fields:

        {

        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • plan_quantity: IntegerField,
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/

        GET POST OPTIONS

        List Create Subscriptions

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        customer	Customer
        start_date	Start Date
        next_payment_date	Next Payment Date
        is_active	Is Active
        latest_payment	Latest Payment

        
        

        Request Fields:

        {

        • customer: PrimaryKeyRelatedField, Required Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_name: ReadOnlyField,
        • plan_id: ReadOnlyField,
        • payment_id: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_amount_paid: ReadOnlyField,
        • plan_latest_transaction_date: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • start_date: DateTimeField,
        • next_payment_date: DateTimeField,
        • is_active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField, Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/active-trial/

        GET POST OPTIONS

        Activate Trial Subscription

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • customer: PrimaryKeyRelatedField, Required Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_name: ReadOnlyField,
        • plan_id: ReadOnlyField,
        • payment_id: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_amount_paid: ReadOnlyField,
        • plan_latest_transaction_date: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • start_date: DateTimeField,
        • next_payment_date: DateTimeField,
        • is_active: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • customer: PrimaryKeyRelatedField, Help Text
        • latest_payment: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/subscriptions/activate/

        GET POST OPTIONS

        Subscription Activate

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • user: IntegerField, Required
        • subscription_plan: IntegerField, Required
        • phone: CharField Required

        }

        
        

        Response Fields:

        {

        • user: IntegerField,
        • subscription_plan: IntegerField,
        • phone: CharField

        }
    • • swap_horiz /api/v1/subscriptions/payment/<str:reference_number>/

        GET OPTIONS

        Retrieve Subscription Payment By Reference Number

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

  • stock-in-logs

    • • swap_horiz /api/v1/stock-in-logs/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Stock In Log

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: ImageField,
        • quantity: IntegerField, Required
        • cost_per_unit: DecimalField, Required
        • received_date: DateField, Required
        • remarks: CharField,
        • product_variant: PrimaryKeyRelatedField, Required Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • quantity: IntegerField,
        • cost_per_unit: DecimalField,
        • total_cost: DecimalField,
        • received_date: DateField,
        • remarks: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField, Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/stock-in-logs/

        GET POST OPTIONS

        List Create Stock In Logs

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        product_variant	Product Variant
        supplier	Supplier
        quantity	Quantity
        cost_per_unit	Cost Per Unit
        total_cost	Total Cost
        received_date	Received Date
        remarks	Remarks
        device	Device

        
        

        Request Fields:

        {

        • image: ImageField,
        • quantity: IntegerField, Required
        • cost_per_unit: DecimalField, Required
        • received_date: DateField, Required
        • remarks: CharField,
        • product_variant: PrimaryKeyRelatedField, Required Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • quantity: IntegerField,
        • cost_per_unit: DecimalField,
        • total_cost: DecimalField,
        • received_date: DateField,
        • remarks: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField, Help Text
        • supplier: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField Help Text

        }

  • product-variant-adverts

    • • swap_horiz /api/v1/product-variant-adverts/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Variant Advert

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • title: CharField,
        • sub_title: CharField,
        • color: CharField,
        • active: BooleanField,
        • price: DecimalField,
        • discount: DecimalField,
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • product_variant_details: ProductVariantSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • product_name: ReadOnlyField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • description: ReadOnlyField,
          • is_low_stock: ReadOnlyField,
          • attributes_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • name: ReadOnlyField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • value: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • attribute: PrimaryKeyRelatedField Help Text

            }
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • active: BooleanField,
          • sku: CharField,
          • price: DecimalField,
          • discount: DecimalField,
          • initial_stock: IntegerField,
          • stock: IntegerField,
          • low_stock_threshold: IntegerField,
          • thumbnail_url: URLField,
          • poster_url: URLField,
          • preview_url: URLField,
          • sprites_url: URLField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • product: PrimaryKeyRelatedField, Help Text
          • shop: PrimaryKeyRelatedField, Help Text
          • attributes: ManyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • title: CharField,
        • sub_title: CharField,
        • color: CharField,
        • active: BooleanField,
        • price: DecimalField,
        • discount: DecimalField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-variant-adverts/

        GET POST OPTIONS

        List Create Product Variant Adverts

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        title	Title
        sub_title	Sub Title
        color	Color
        active	Active
        price	Price
        discount	Discount
        product_variant	Product Variant

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • title: CharField,
        • sub_title: CharField,
        • color: CharField,
        • active: BooleanField,
        • price: DecimalField,
        • discount: DecimalField,
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • product_variant_details: ProductVariantSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • product_name: ReadOnlyField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • description: ReadOnlyField,
          • is_low_stock: ReadOnlyField,
          • attributes_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • name: ReadOnlyField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • value: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • attribute: PrimaryKeyRelatedField Help Text

            }
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • active: BooleanField,
          • sku: CharField,
          • price: DecimalField,
          • discount: DecimalField,
          • initial_stock: IntegerField,
          • stock: IntegerField,
          • low_stock_threshold: IntegerField,
          • thumbnail_url: URLField,
          • poster_url: URLField,
          • preview_url: URLField,
          • sprites_url: URLField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • product: PrimaryKeyRelatedField, Help Text
          • shop: PrimaryKeyRelatedField, Help Text
          • attributes: ManyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • title: CharField,
        • sub_title: CharField,
        • color: CharField,
        • active: BooleanField,
        • price: DecimalField,
        • discount: DecimalField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Help Text

        }

  • notifications

    • • swap_horiz /api/v1/notifications/<uuid:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Notification

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • image: ImageField,
        • unique_hash: CharField,
        • not_body: CharField,
        • not_cust_name: CharField,
        • not_status: CharField,
        • not_subject: CharField,
        • not_device_id: PrimaryKeyRelatedField, Help Text
        • not_usr_id: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • not_id: UUIDField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • unique_hash: CharField,
        • not_body: CharField,
        • not_cust_name: CharField,
        • not_status: CharField,
        • not_subject: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • not_device_id: PrimaryKeyRelatedField, Help Text
        • not_usr_id: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/notifications/

        GET POST OPTIONS

        List Create Notifications

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        unique_hash	Unique Hash
        not_id	Not Id
        not_body	Not Body
        not_cust_name	Not Cust Name
        not_status	Not Status
        not_subject	Not Subject
        not_device_id	Not Device Id
        not_usr_id	Not Usr Id

        
        

        Request Fields:

        {

        • image: ImageField,
        • unique_hash: CharField,
        • not_body: CharField,
        • not_cust_name: CharField,
        • not_status: CharField,
        • not_subject: CharField,
        • not_device_id: PrimaryKeyRelatedField, Help Text
        • not_usr_id: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • not_id: UUIDField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • unique_hash: CharField,
        • not_body: CharField,
        • not_cust_name: CharField,
        • not_status: CharField,
        • not_subject: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • not_device_id: PrimaryKeyRelatedField, Help Text
        • not_usr_id: PrimaryKeyRelatedField Help Text

        }

  • mpesa-payments

    • • swap_horiz /api/v1/mpesa-payments/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Mpesa Payment

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • plan_quantity: IntegerField,
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

  • purchase-devices

    • • swap_horiz /api/v1/purchase-devices/<str:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Purchase Device

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • device_id: CharField, Required
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField, Required
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • os_version: IntegerField, Required
        • os_version_name: CharField, Required
        • firebase_token: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • device_id: CharField,
        • delivery_addresses: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField,
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • is_primary_device: BooleanField,
        • is_verifed: BooleanField,
        • os_version: IntegerField,
        • os_version_name: CharField,
        • firebase_token: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-devices/

        GET POST OPTIONS

        List Create Purchase Devices

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        device_id	Device Id
        description	Description
        user	User
        device_type	Device Type
        is_primary_device	Is Primary Device
        is_verifed	Is Verifed
        os_version	Os Version
        os_version_name	Os Version Name
        firebase_token	Firebase Token

        
        

        Request Fields:

        {

        • device_id: CharField, Required
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField, Required
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • os_version: IntegerField, Required
        • os_version_name: CharField, Required
        • firebase_token: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • device_id: CharField,
        • delivery_addresses: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • image: ImageField,
        • name: CharField,
        • description: CharField,
        • device_type: ChoiceField,
          Choices

          Value	Meaning
          M	Mobile
          T	Tablet
          D	Desktop

        • is_primary_device: BooleanField,
        • is_verifed: BooleanField,
        • os_version: IntegerField,
        • os_version_name: CharField,
        • firebase_token: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • delivery-addresses

    • • swap_horiz /api/v1/delivery-addresses/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Delivery Address

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField, Required
        • lng: FloatField, Required
        • notes: CharField,
        • is_default_address: BooleanField,
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField,
        • lng: FloatField,
        • notes: CharField,
        • is_default_address: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/delivery-addresses/<str:device_id>/

        GET POST OPTIONS

        List Create Delivery Addresss

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        purchase_device	Purchase Device
        user	User
        location_type	Location Type
        floor_number	Floor Number
        door_number	Door Number
        building_name	Building Name
        additional_info	Additional Info
        lat	Lat
        lng	Lng
        notes	Notes
        is_default_address	Is Default Address

        
        

        Request Fields:

        {

        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField, Required
        • lng: FloatField, Required
        • notes: CharField,
        • is_default_address: BooleanField,
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField,
        • lng: FloatField,
        • notes: CharField,
        • is_default_address: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/delivery-addresses/<str:device_id>/<int:pk>/default/

        PATCH

        Mark Default Delivery Address

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAddressOwner	A base class from which all permission classes should inherit.

        
        

        Request Fields:

        {

        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField, Required
        • lng: FloatField, Required
        • notes: CharField,
        • is_default_address: BooleanField,
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • location_type: ChoiceField,
          Choices

          Value	Meaning
          HS	House
          HT	Hotel
          AP	Apartment
          OF	Office
          OT	Other

        • floor_number: IntegerField,
        • door_number: CharField,
        • building_name: CharField,
        • additional_info: CharField,
        • lat: FloatField,
        • lng: FloatField,
        • notes: CharField,
        • is_default_address: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase_device: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • shops

    • • swap_horiz /api/v1/shops/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Shop

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowOnlyGetRequests	Custom permission to allow only GET requests.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • banner_image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • banner_image: Base64ImageField,
        • banner_cache_image: SerializerMethodField,
        • banner_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/shops/

        GET POST OPTIONS

        List Create Shops

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        AllowOnlyGetRequests	Custom permission to allow only GET requests.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        description	Description
        user	User
        support_email	Support Email
        support_phone	Support Phone

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • banner_image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • user: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • banner_image: Base64ImageField,
        • banner_cache_image: SerializerMethodField,
        • banner_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • location: CharField,
        • support_email: EmailField,
        • support_phone: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • product-variants

    • • swap_horiz /api/v1/product-variants/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Variant

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField, Required
        • price: DecimalField,
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • main_file: URLField,
        • product: PrimaryKeyRelatedField, Required Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • product_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • description: ReadOnlyField,
        • is_low_stock: ReadOnlyField,
        • attributes_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • name: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • value: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • attribute: PrimaryKeyRelatedField Help Text

          }
        • product_image: Base64ImageField,
        • product_cache_image: SerializerMethodField,
        • product_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField,
        • price: DecimalField,
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product: PrimaryKeyRelatedField, Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-variants/

        GET POST OPTIONS

        List Create Product Variants

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        active	Active
        product	Product
        sku	Sku
        attributes	Attributes
        price	Price
        discount	Discount
        initial_stock	Initial Stock
        stock	Stock
        low_stock_threshold	Low Stock Threshold
        shop	Shop
        thumbnail_url	Thumbnail Url
        poster_url	Poster Url
        preview_url	Preview Url
        sprites_url	Sprites Url
        main_file	Main File
        product_sub_category	Product Sub Category
        product_category	Product Category

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField, Required
        • price: DecimalField,
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • main_file: URLField,
        • product: PrimaryKeyRelatedField, Required Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • product_name: ReadOnlyField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • description: ReadOnlyField,
        • is_low_stock: ReadOnlyField,
        • attributes_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • name: ReadOnlyField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • value: CharField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • attribute: PrimaryKeyRelatedField Help Text

          }
        • product_image: Base64ImageField,
        • product_cache_image: SerializerMethodField,
        • product_avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • active: BooleanField,
        • sku: CharField,
        • price: DecimalField,
        • discount: DecimalField,
        • initial_stock: IntegerField,
        • stock: IntegerField,
        • low_stock_threshold: IntegerField,
        • thumbnail_url: URLField,
        • poster_url: URLField,
        • preview_url: URLField,
        • sprites_url: URLField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • product: PrimaryKeyRelatedField, Help Text
        • shop: PrimaryKeyRelatedField, Help Text
        • attributes: ManyRelatedField Help Text

        }

  • purchases

    • • swap_horiz /api/v1/purchases/mpesa-payments/

        POST OPTIONS

        List Create Direct Purchase Mpesa Payments

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        title	Title
        phone	Phone
        email	Email
        status	Status
        created_at	Created At
        updated_at	Updated At
        current_payment	Current Payment
        source	Source
        device	Device
        ip_address	Ip Address
        delivery_address	Delivery Address
        notes	Notes
        user	User
        service_fee	Service Fee
        delivery_fee	Delivery Fee

        
        

        Request Fields:

        {

        • product_variant: IntegerField, Required
        • quantity: IntegerField, Required
        • name: CharField, Required
        • email: EmailField, Required
        • phone: CharField, Required

        }

        
        

        Response Fields:

        {

        • name: CharField,
        • email: EmailField,
        • phone: CharField,
        • id: ReadOnlyField,
        • total_items: ReadOnlyField,
        • total_price: ReadOnlyField,
        • status: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField

        }
    • • swap_horiz /api/v1/purchases/me/

        GET POST OPTIONS

        List Create My Purchases

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        title	Title
        phone	Phone
        email	Email
        status	Status
        created_at	Created At
        updated_at	Updated At
        current_payment	Current Payment
        source	Source
        device	Device
        ip_address	Ip Address
        delivery_address	Delivery Address
        notes	Notes
        user	User
        service_fee	Service Fee
        delivery_fee	Delivery Fee

        
        

        Request Fields:

        {

        • raw_items: ListSerializer,
          Item structure

          {

          • product_variant: IntegerField, Required
          • quantity: IntegerField Required

          }
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • notes: CharField,
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/stats/<str:type>/

        GET OPTIONS

        List Dynamic Purchases Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        `type` = {stat_types}
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        title	Title
        phone	Phone
        email	Email
        status	Status
        created_at	Created At
        updated_at	Updated At
        current_payment	Current Payment
        source	Source
        device	Device
        ip_address	Ip Address
        delivery_address	Delivery Address
        notes	Notes
        user	User
        service_fee	Service Fee
        delivery_fee	Delivery Fee

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/update-email-count/

        POST OPTIONS

        Update Purchase Email Count

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        No output data specified

    • • swap_horiz /api/v1/purchases/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Purchase

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        
        

        Request Fields:

        {

        • raw_items: ListSerializer,
          Item structure

          {

          • product_variant: IntegerField, Required
          • quantity: IntegerField Required

          }
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • notes: CharField,
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/<int:pk>/mpesa-payments/

        GET POST OPTIONS

        List Create Purchase Mpesa Payments

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        reference_number	Reference Number
        payment_for	Payment For
        phone_number	Phone Number
        phone_number_hash	Phone Number Hash
        phone_number_paid	Phone Number Paid
        phone_number_paid_hash	Phone Number Paid Hash
        transaction_id	Transaction Id
        amount	Amount
        amount_paid	Amount Paid
        transaction_date	Transaction Date
        request_trans_time	Request Trans Time
        initiated	Initiated
        completed	Completed
        request_code	Request Code
        request_description	Request Description
        result_code	Result Code
        result_description	Result Description
        subscription	Subscription
        plan	Plan
        plan_quantity	Plan Quantity
        purchase	Purchase
        transaction_type	Transaction Type
        stk_triggered	Stk Triggered
        status	Status
        checkout_request_id	Checkout Request Id
        first_name	First Name
        middle_name	Middle Name
        last_name	Last Name
        trans_time	Trans Time
        confirmed	Confirmed

        
        

        Request Fields:

        {

        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • plan_quantity: IntegerField,
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • plan_id: ReadOnlyField,
        • plan_name: ReadOnlyField,
        • plan_amount: ReadOnlyField,
        • plan_discount: ReadOnlyField,
        • plan_interval: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • reference_number: CharField,
        • payment_for: ChoiceField,
          Choices

          Value	Meaning
          P	Product
          S	Subscription

        • phone_number: CharField,
        • phone_number_hash: CharField,
        • phone_number_paid: CharField,
        • phone_number_paid_hash: CharField,
        • transaction_id: CharField,
        • amount: FloatField,
        • amount_paid: FloatField,
        • transaction_date: DateTimeField,
        • request_trans_time: IntegerField,
        • initiated: BooleanField,
        • completed: BooleanField,
        • request_code: CharField,
        • request_description: CharField,
        • result_code: CharField,
        • result_description: CharField,
        • plan_quantity: IntegerField,
        • transaction_type: CharField,
        • stk_triggered: BooleanField,
        • status: CharField,
        • checkout_request_id: CharField,
        • first_name: CharField,
        • middle_name: CharField,
        • last_name: CharField,
        • trans_time: IntegerField,
        • confirmed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • subscription: PrimaryKeyRelatedField, Help Text
        • plan: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/<str:reference_number>/

        GET OPTIONS

        Retrieve Purchase By Reference Number

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchases/

        GET POST OPTIONS

        List Create Purchases

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        title	Title
        phone	Phone
        email	Email
        status	Status
        created_at	Created At
        updated_at	Updated At
        current_payment	Current Payment
        source	Source
        device	Device
        ip_address	Ip Address
        delivery_address	Delivery Address
        notes	Notes
        user	User
        service_fee	Service Fee
        delivery_fee	Delivery Fee

        
        

        Request Fields:

        {

        • raw_items: ListSerializer,
          Item structure

          {

          • product_variant: IntegerField, Required
          • quantity: IntegerField Required

          }
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • notes: CharField,
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }

  • purchase-items

    • • swap_horiz /api/v1/purchase-items/stats/<str:type>/

        GET OPTIONS

        List Dynamic Purchase Items Stats

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        Group statistics by:
        `type` = {stat_types}
        

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        purchase	Purchase
        product_variant	Product Variant
        quantity	Quantity
        price	Price
        discount	Discount
        purchase_id	Purchase Id
        purchase_email	Purchase Email
        purchase_status	Purchase Status
        purchase_created_date	Purchase Created Date
        purchase_modified_date	Purchase Modified Date
        product_id	Product Id
        product_name	Product Name
        product_variant_id	Product Variant Id
        product_sku	Product Sku
        product_variant_name	Product Variant Name
        shop_name	Shop Name
        shop_id	Shop Id
        payment_reference	Payment Reference

        
        

        Request Fields:

        No input data specified

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • quantity: IntegerField,
        • price: DecimalField,
        • discount: DecimalField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/stats/

        GET POST OPTIONS

        Get Stats Purchase Items

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAuthenticated	Allows access only to authenticated users.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        purchase	Purchase
        product_variant	Product Variant
        quantity	Quantity
        price	Price
        discount	Discount
        purchase_id	Purchase Id
        purchase_email	Purchase Email
        purchase_status	Purchase Status
        purchase_created_date	Purchase Created Date
        purchase_modified_date	Purchase Modified Date
        product_id	Product Id
        product_name	Product Name
        product_variant_id	Product Variant Id
        product_sku	Product Sku
        product_variant_name	Product Variant Name
        shop_name	Shop Name
        shop_id	Shop Id
        payment_reference	Payment Reference

        
        

        Request Fields:

        {

        • purchase_device: PrimaryKeyRelatedField, Help Text
        • quantity: IntegerField,
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • quantity: IntegerField,
        • price: DecimalField,
        • discount: DecimalField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Purchase Item

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • purchase_device: PrimaryKeyRelatedField, Help Text
        • quantity: IntegerField,
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/

        GET POST OPTIONS

        List Create Purchase Items

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        purchase	Purchase
        product_variant	Product Variant
        quantity	Quantity
        price	Price
        discount	Discount

        
        

        Request Fields:

        {

        • purchase_device: PrimaryKeyRelatedField, Help Text
        • quantity: IntegerField,
        • purchase: PrimaryKeyRelatedField, Help Text
        • product_variant: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • total_price: ReadOnlyField,
        • total_discount: ReadOnlyField,
        • total_items: ReadOnlyField,
        • items: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • total_price: ReadOnlyField,
          • name: ReadOnlyField,
          • variant_name: ReadOnlyField,
          • description: ReadOnlyField,
          • attributes: ReadOnlyField,
          • venue: ReadOnlyField,
          • start_time: ReadOnlyField,
          • end_time: ReadOnlyField,
          • thumbnail_url: ReadOnlyField,
          • preview_url: ReadOnlyField,
          • sprites_url: ReadOnlyField,
          • poster_url: ReadOnlyField,
          • service_fee: ReadOnlyField,
          • delivery_fee: ReadOnlyField,
          • product_category_name: ReadOnlyField,
          • product_sub_category_name: ReadOnlyField,
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • product_variant_image: Base64ImageField,
          • product_variant_cache_image: SerializerMethodField,
          • product_variant_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • quantity: IntegerField,
          • price: DecimalField,
          • discount: DecimalField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase: PrimaryKeyRelatedField, Help Text
          • product_variant: PrimaryKeyRelatedField Help Text

          }
        • current_reference_number: ReadOnlyField,
        • current_payment_status: ReadOnlyField,
        • current_payment_status_display: ReadOnlyField,
        • current_payment_result_description: ReadOnlyField,
        • delivery_address_details: DeliveryAddressSerializer,
          Item structure

          {

          • id: IntegerField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • location_type: ChoiceField,
            Choices

            Value	Meaning
            HS	House
            HT	Hotel
            AP	Apartment
            OF	Office
            OT	Other

          • floor_number: IntegerField,
          • door_number: CharField,
          • building_name: CharField,
          • additional_info: CharField,
          • lat: FloatField,
          • lng: FloatField,
          • notes: CharField,
          • is_default_address: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • purchase_device: PrimaryKeyRelatedField, Help Text
          • user: PrimaryKeyRelatedField Help Text

          }
        • service_fee: ReadOnlyField,
        • delivery_fee: ReadOnlyField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • title: CharField,
        • phone: CharField,
        • email: EmailField,
        • status: ChoiceField,
          Choices

          Value	Meaning
          CART	Cart
          PENDING	Pending
          PROCESSING	Processing
          PROCESSED	Processed
          DELIVERING	Delivering
          DELIVERED	Delivered
          PAID	Paid
          CANCELED	Canceled
          COMPLETED	Completed

        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • source: ChoiceField,
          Choices

          Value	Meaning
          online	Online
          shop	Shop
          gate	Gate

        • ip_address: CharField,
        • notes: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • current_payment: PrimaryKeyRelatedField, Help Text
        • device: PrimaryKeyRelatedField, Help Text
        • delivery_address: PrimaryKeyRelatedField, Help Text
        • user: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/purchase-items/redeem/

        POST OPTIONS

        Redeem Purchase Item

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        
        

        Request Fields:

        {

        • reference: CharField, Required
        • hash: CharField, Required
        • status: ChoiceField Required
          Choices

          Value	Meaning
          PENDING	PENDING
          REDEEMING	REDEEMING
          REDEEMED	REDEEMED

        }

        
        

        Response Fields:

        {

        • reference: CharField,
        • hash: CharField,
        • status: ChoiceField
          Choices

          Value	Meaning
          PENDING	PENDING
          REDEEMING	REDEEMING
          REDEEMED	REDEEMED

        }

  • product-categorys

    • • swap_horiz /api/v1/product-categorys/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Category

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-categorys/

        GET POST OPTIONS

        List Create Product Categorys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        description	Description

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField Help Text

        }

  • product-sub-categorys

    • • swap_horiz /api/v1/product-sub-categorys/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product Sub Category

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • category: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • products: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • variants_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • image: Base64ImageField,
            • cache_image: SerializerMethodField,
            • avatar_image: SerializerMethodField,
            • product_name: ReadOnlyField,
            • category_name: ReadOnlyField,
            • sub_category_name: ReadOnlyField,
            • description: ReadOnlyField,
            • is_low_stock: ReadOnlyField,
            • attributes_details: ListSerializer,
              Item structure

              {

              • id: IntegerField,
              • name: ReadOnlyField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • value: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • attribute: PrimaryKeyRelatedField Help Text

              }
            • product_image: Base64ImageField,
            • product_cache_image: SerializerMethodField,
            • product_avatar_image: SerializerMethodField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • active: BooleanField,
            • sku: CharField,
            • price: DecimalField,
            • discount: DecimalField,
            • initial_stock: IntegerField,
            • stock: IntegerField,
            • low_stock_threshold: IntegerField,
            • thumbnail_url: URLField,
            • poster_url: URLField,
            • preview_url: URLField,
            • sprites_url: URLField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • product: PrimaryKeyRelatedField, Help Text
            • shop: PrimaryKeyRelatedField, Help Text
            • attributes: ManyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • description: CharField,
          • base_price: DecimalField,
          • created_at: DateTimeField,
          • updated_at: DateTimeField,
          • venue: CharField,
          • start_time: DateTimeField,
          • end_time: DateTimeField,
          • has_unlimited_stock: BooleanField,
          • active: BooleanField,
          • trailer_url: URLField,
          • trailer_preview_url: URLField,
          • can_be_redeemed: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • sub_category: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • category: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/product-sub-categorys/

        GET POST OPTIONS

        List Create Product Sub Categorys

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        description	Description
        category	Category

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • category: PrimaryKeyRelatedField Required Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • products: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • variants_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • image: Base64ImageField,
            • cache_image: SerializerMethodField,
            • avatar_image: SerializerMethodField,
            • product_name: ReadOnlyField,
            • category_name: ReadOnlyField,
            • sub_category_name: ReadOnlyField,
            • description: ReadOnlyField,
            • is_low_stock: ReadOnlyField,
            • attributes_details: ListSerializer,
              Item structure

              {

              • id: IntegerField,
              • name: ReadOnlyField,
              • created: DateTimeField,
              • modified: DateTimeField,
              • value: CharField,
              • created_by: PrimaryKeyRelatedField, Help Text
              • updated_by: PrimaryKeyRelatedField, Help Text
              • attribute: PrimaryKeyRelatedField Help Text

              }
            • product_image: Base64ImageField,
            • product_cache_image: SerializerMethodField,
            • product_avatar_image: SerializerMethodField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • name: CharField,
            • active: BooleanField,
            • sku: CharField,
            • price: DecimalField,
            • discount: DecimalField,
            • initial_stock: IntegerField,
            • stock: IntegerField,
            • low_stock_threshold: IntegerField,
            • thumbnail_url: URLField,
            • poster_url: URLField,
            • preview_url: URLField,
            • sprites_url: URLField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • product: PrimaryKeyRelatedField, Help Text
            • shop: PrimaryKeyRelatedField, Help Text
            • attributes: ManyRelatedField Help Text

            }
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • description: CharField,
          • base_price: DecimalField,
          • created_at: DateTimeField,
          • updated_at: DateTimeField,
          • venue: CharField,
          • start_time: DateTimeField,
          • end_time: DateTimeField,
          • has_unlimited_stock: BooleanField,
          • active: BooleanField,
          • trailer_url: URLField,
          • trailer_preview_url: URLField,
          • can_be_redeemed: BooleanField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • sub_category: PrimaryKeyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • category: PrimaryKeyRelatedField Help Text

        }

  • products

    • • swap_horiz /api/v1/products/<int:pk>/

        GET PUT PATCH DELETE OPTIONS

        Retrieve Update Destroy Product

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • base_price: DecimalField, Required
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • sub_category: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • variants_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • product_name: ReadOnlyField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • description: ReadOnlyField,
          • is_low_stock: ReadOnlyField,
          • attributes_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • name: ReadOnlyField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • value: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • attribute: PrimaryKeyRelatedField Help Text

            }
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • active: BooleanField,
          • sku: CharField,
          • price: DecimalField,
          • discount: DecimalField,
          • initial_stock: IntegerField,
          • stock: IntegerField,
          • low_stock_threshold: IntegerField,
          • thumbnail_url: URLField,
          • poster_url: URLField,
          • preview_url: URLField,
          • sprites_url: URLField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • product: PrimaryKeyRelatedField, Help Text
          • shop: PrimaryKeyRelatedField, Help Text
          • attributes: ManyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • base_price: DecimalField,
        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField Help Text

        }
    • • swap_horiz /api/v1/products/

        GET POST OPTIONS

        List Create Products

        Copy to clipboard Copy Link

        Open Link  

        ---

        • Description
        • Authentication
        • Permissions
        • Filters

        No description provided by developer

        Action is allowed if any of these auth types is provided(logic OR)

        Type	Description
        OAuth2Authentication	OAuth 2 authentication backend using django-oauth-toolkit
        SessionAuthentication	Use Django's session framework for authentication.

        Action is allowed when all of conditions are satisfied(logic AND)

        Type	Description
        IsAdminOrReadOnly	The request is authenticated as a user, or is a read-only request.

        Param name	Description
        created	Created
        modified	Modified
        created_by	Created By
        updated_by	Updated By
        name	Name
        description	Description
        base_price	Base Price
        created_at	Created At
        updated_at	Updated At
        venue	Venue
        start_time	Start Time
        end_time	End Time
        has_unlimited_stock	Has Unlimited Stock
        active	Active
        sub_category	Sub Category
        trailer_url	Trailer Url
        trailer_preview_url	Trailer Preview Url
        can_be_redeemed	Can Be Redeemed
        product_sub_category	Product Sub Category
        product_category	Product Category

        
        

        Request Fields:

        {

        • image: Base64ImageField,
        • name: CharField, Required
        • description: CharField,
        • base_price: DecimalField, Required
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • sub_category: PrimaryKeyRelatedField Help Text

        }

        
        

        Response Fields:

        {

        • id: IntegerField,
        • image: Base64ImageField,
        • cache_image: SerializerMethodField,
        • avatar_image: SerializerMethodField,
        • category_name: ReadOnlyField,
        • sub_category_name: ReadOnlyField,
        • variants_details: ListSerializer,
          Item structure

          {

          • id: IntegerField,
          • image: Base64ImageField,
          • cache_image: SerializerMethodField,
          • avatar_image: SerializerMethodField,
          • product_name: ReadOnlyField,
          • category_name: ReadOnlyField,
          • sub_category_name: ReadOnlyField,
          • description: ReadOnlyField,
          • is_low_stock: ReadOnlyField,
          • attributes_details: ListSerializer,
            Item structure

            {

            • id: IntegerField,
            • name: ReadOnlyField,
            • created: DateTimeField,
            • modified: DateTimeField,
            • value: CharField,
            • created_by: PrimaryKeyRelatedField, Help Text
            • updated_by: PrimaryKeyRelatedField, Help Text
            • attribute: PrimaryKeyRelatedField Help Text

            }
          • product_image: Base64ImageField,
          • product_cache_image: SerializerMethodField,
          • product_avatar_image: SerializerMethodField,
          • created: DateTimeField,
          • modified: DateTimeField,
          • name: CharField,
          • active: BooleanField,
          • sku: CharField,
          • price: DecimalField,
          • discount: DecimalField,
          • initial_stock: IntegerField,
          • stock: IntegerField,
          • low_stock_threshold: IntegerField,
          • thumbnail_url: URLField,
          • poster_url: URLField,
          • preview_url: URLField,
          • sprites_url: URLField,
          • created_by: PrimaryKeyRelatedField, Help Text
          • updated_by: PrimaryKeyRelatedField, Help Text
          • product: PrimaryKeyRelatedField, Help Text
          • shop: PrimaryKeyRelatedField, Help Text
          • attributes: ManyRelatedField Help Text

          }
        • created: DateTimeField,
        • modified: DateTimeField,
        • name: CharField,
        • description: CharField,
        • base_price: DecimalField,
        • created_at: DateTimeField,
        • updated_at: DateTimeField,
        • venue: CharField,
        • start_time: DateTimeField,
        • end_time: DateTimeField,
        • has_unlimited_stock: BooleanField,
        • active: BooleanField,
        • trailer_url: URLField,
        • trailer_preview_url: URLField,
        • can_be_redeemed: BooleanField,
        • created_by: PrimaryKeyRelatedField, Help Text
        • updated_by: PrimaryKeyRelatedField, Help Text
        • sub_category: PrimaryKeyRelatedField Help Text

        }