Transaction API API Reference

Transactions API of My-POP

API Endpoint
http://my-pop.co.uk/
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http
Version: 1.0.0

Paths

Find all the Transactions

GET /transactions

Find all the Transactions

Success

404 Not Found

Not Found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "type": {
      "id": "number (double)",
      "name": "string",
      "description": "string"
    },
    "status": {
      "id": "string",
      "name": "string"
    },
    "versionNumber": "string",
    "creationDateTime": "string (date)",
    "validityPeriod": {
      "fromDate": "string (date)",
      "toDate": "string (date)"
    },
    "details": {
      "remarks": "string",
      "numberOfItemsPurchased": "number (double)"
    },
    "relatedTransactions": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "type": "string",
        "status": {
          "id": "string",
          "name": "string"
        }
      }
    ],
    "channels": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "type": "string",
        "status": {
          "id": "string",
          "name": "string"
        }
      }
    ],
    "parts": {
      "merchant": {
        "id": "string",
        "description": "string",
        "name": "string",
        "type": "string",
        "status": {
          "id": "string",
          "name": "string"
        }
      },
      "store": {
        "id": "string",
        "description": "string",
        "name": "string",
        "type": "string",
        "status": {
          "id": "string",
          "name": "string"
        },
        "address": {
          "street": "string",
          "town": "string",
          "buildingName": "string",
          "buildingNumber": "integer (int64)",
          "country": "string",
          "county": "string",
          "occupant": "string",
          "postalCode": "integer (int64)",
          "primaryClassification": "string",
          "subLocality": "string",
          "subStreet": "string",
          "subUnit": "string"
        }
      },
      "payments": [
        {
          "id": "integer (int64)",
          "description": "string",
          "name": "string",
          "type": "string",
          "paymentReference": "string",
          "cardReference": "string",
          "cardType": "string",
          "terminalId": "string",
          "date": "string (date)",
          "amount": "number (double)",
          "balance": "number (double)",
          "change": "number (double)",
          "authCode": "string"
        }
      ],
      "customer": {
        "id": "string",
        "description": "string",
        "name": "string",
        "type": "string",
        "status": {
          "id": "string",
          "name": "string"
        },
        "address": {
          "street": "string",
          "town": "string",
          "buildingName": "string",
          "buildingNumber": "integer (int64)",
          "country": "string",
          "county": "string",
          "occupant": "string",
          "postalCode": "integer (int64)",
          "primaryClassification": "string",
          "subLocality": "string",
          "subStreet": "string",
          "subUnit": "string"
        }
      },
      "agent": {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "type": "string",
        "status": {
          "id": "string",
          "name": "string"
        }
      },
      "loyalty": {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)",
        "type": "string"
      },
      "discounts": [
        {
          "id": "integer (int64)",
          "description": "string",
          "name": "string",
          "quantity": "integer (int64)",
          "type": "string",
          "pattern": "string",
          "unitOfMeasure": "string"
        }
      ],
      "taxes": [
        {
          "id": "integer (int64)",
          "description": "string",
          "name": "string",
          "quantity": "integer (int64)"
        }
      ],
      "price": {
        "currency": "number (double)",
        "pattern": "string",
        "unitOfMeasure": "string"
      },
      "lineItems": [
        {
          "customerProduct": {
            "id": "number (double)",
            "name": "string",
            "description": "string",
            "type": {
              "id": "number (double)",
              "name": "string",
              "description": "string"
            },
            "productType": {
              "id": "integer (int64)",
              "name": "string",
              "description": "string",
              "productSubType": {
                "id": "integer (int64)",
                "name": "string",
                "description": "string"
              }
            },
            "status": {
              "id": "string",
              "name": "string"
            },
            "warranty": {
              "id": "integer (int64)",
              "name": "string",
              "description": "string",
              "validityPeriod": {
                "fromDate": "string (date)",
                "toDate": "string (date)"
              }
            },
            "quantity": "integer (int64)",
            "specifications": [
              {
                "id": "integer (int64)",
                "name": "string",
                "description": "string",
                "characteristicValues": "string"
              }
            ]
          },
          "discounts": [
            {
              "id": "integer (int64)",
              "description": "string",
              "name": "string",
              "quantity": "integer (int64)",
              "type": "string",
              "pattern": "string",
              "unitOfMeasure": "string"
            }
          ],
          "price": {
            "currency": "number (double)",
            "pattern": "string",
            "unitOfMeasure": "string"
          },
          "taxes": [
            {
              "id": "integer (int64)",
              "description": "string",
              "name": "string",
              "quantity": "integer (int64)"
            }
          ]
        }
      ]
    },
    "tags": [
      {
        "id": "integer (int64)",
        "name": "string",
        "description": "string"
      }
    ]
  }
]
Response Example (404 Not Found)
Response Example (default )

Creates new Transaction

POST /transactions

Creates new Transaction

payload of Transaction

Request Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": {
    "id": "number (double)",
    "name": "string",
    "description": "string"
  },
  "status": {
    "id": "string",
    "name": "string"
  },
  "versionNumber": "string",
  "creationDateTime": "string (date)",
  "validityPeriod": {
    "fromDate": "string (date)",
    "toDate": "string (date)"
  },
  "details": {
    "remarks": "string",
    "numberOfItemsPurchased": "number (double)"
  },
  "relatedTransactions": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "channels": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "parts": {
    "merchant": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    },
    "store": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      },
      "address": {
        "street": "string",
        "town": "string",
        "buildingName": "string",
        "buildingNumber": "integer (int64)",
        "country": "string",
        "county": "string",
        "occupant": "string",
        "postalCode": "integer (int64)",
        "primaryClassification": "string",
        "subLocality": "string",
        "subStreet": "string",
        "subUnit": "string"
      }
    },
    "payments": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "type": "string",
        "paymentReference": "string",
        "cardReference": "string",
        "cardType": "string",
        "terminalId": "string",
        "date": "string (date)",
        "amount": "number (double)",
        "balance": "number (double)",
        "change": "number (double)",
        "authCode": "string"
      }
    ],
    "customer": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      },
      "address": {
        "street": "string",
        "town": "string",
        "buildingName": "string",
        "buildingNumber": "integer (int64)",
        "country": "string",
        "county": "string",
        "occupant": "string",
        "postalCode": "integer (int64)",
        "primaryClassification": "string",
        "subLocality": "string",
        "subStreet": "string",
        "subUnit": "string"
      }
    },
    "agent": {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    },
    "loyalty": {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)",
      "type": "string"
    },
    "discounts": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)",
        "type": "string",
        "pattern": "string",
        "unitOfMeasure": "string"
      }
    ],
    "taxes": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)"
      }
    ],
    "price": {
      "currency": "number (double)",
      "pattern": "string",
      "unitOfMeasure": "string"
    },
    "lineItems": [
      {
        "customerProduct": {
          "id": "number (double)",
          "name": "string",
          "description": "string",
          "type": {
            "id": "number (double)",
            "name": "string",
            "description": "string"
          },
          "productType": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "productSubType": {
              "id": "integer (int64)",
              "name": "string",
              "description": "string"
            }
          },
          "status": {
            "id": "string",
            "name": "string"
          },
          "warranty": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "validityPeriod": {
              "fromDate": "string (date)",
              "toDate": "string (date)"
            }
          },
          "quantity": "integer (int64)",
          "specifications": [
            {
              "id": "integer (int64)",
              "name": "string",
              "description": "string",
              "characteristicValues": "string"
            }
          ]
        },
        "discounts": [
          {
            "id": "integer (int64)",
            "description": "string",
            "name": "string",
            "quantity": "integer (int64)",
            "type": "string",
            "pattern": "string",
            "unitOfMeasure": "string"
          }
        ],
        "price": {
          "currency": "number (double)",
          "pattern": "string",
          "unitOfMeasure": "string"
        },
        "taxes": [
          {
            "id": "integer (int64)",
            "description": "string",
            "name": "string",
            "quantity": "integer (int64)"
          }
        ]
      }
    ]
  },
  "tags": [
    {
      "id": "integer (int64)",
      "name": "string",
      "description": "string"
    }
  ]
}
200 OK

Success

405 Method Not Allowed

Invalid Input

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (405 Method Not Allowed)
Response Example (default )

Find transaction by transactionID

GET /transaction/{id}

Find transaction by transactionID

id

ID to retieve a Transaction

type
string
in
path

Success

401 Unauthorized

Invalid ID supplied

404 Not Found

Transaction not found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": {
    "id": "number (double)",
    "name": "string",
    "description": "string"
  },
  "status": {
    "id": "string",
    "name": "string"
  },
  "versionNumber": "string",
  "creationDateTime": "string (date)",
  "validityPeriod": {
    "fromDate": "string (date)",
    "toDate": "string (date)"
  },
  "details": {
    "remarks": "string",
    "numberOfItemsPurchased": "number (double)"
  },
  "relatedTransactions": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "channels": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "parts": {
    "merchant": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    },
    "store": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      },
      "address": {
        "street": "string",
        "town": "string",
        "buildingName": "string",
        "buildingNumber": "integer (int64)",
        "country": "string",
        "county": "string",
        "occupant": "string",
        "postalCode": "integer (int64)",
        "primaryClassification": "string",
        "subLocality": "string",
        "subStreet": "string",
        "subUnit": "string"
      }
    },
    "payments": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "type": "string",
        "paymentReference": "string",
        "cardReference": "string",
        "cardType": "string",
        "terminalId": "string",
        "date": "string (date)",
        "amount": "number (double)",
        "balance": "number (double)",
        "change": "number (double)",
        "authCode": "string"
      }
    ],
    "customer": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      },
      "address": {
        "street": "string",
        "town": "string",
        "buildingName": "string",
        "buildingNumber": "integer (int64)",
        "country": "string",
        "county": "string",
        "occupant": "string",
        "postalCode": "integer (int64)",
        "primaryClassification": "string",
        "subLocality": "string",
        "subStreet": "string",
        "subUnit": "string"
      }
    },
    "agent": {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    },
    "loyalty": {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)",
      "type": "string"
    },
    "discounts": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)",
        "type": "string",
        "pattern": "string",
        "unitOfMeasure": "string"
      }
    ],
    "taxes": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)"
      }
    ],
    "price": {
      "currency": "number (double)",
      "pattern": "string",
      "unitOfMeasure": "string"
    },
    "lineItems": [
      {
        "customerProduct": {
          "id": "number (double)",
          "name": "string",
          "description": "string",
          "type": {
            "id": "number (double)",
            "name": "string",
            "description": "string"
          },
          "productType": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "productSubType": {
              "id": "integer (int64)",
              "name": "string",
              "description": "string"
            }
          },
          "status": {
            "id": "string",
            "name": "string"
          },
          "warranty": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "validityPeriod": {
              "fromDate": "string (date)",
              "toDate": "string (date)"
            }
          },
          "quantity": "integer (int64)",
          "specifications": [
            {
              "id": "integer (int64)",
              "name": "string",
              "description": "string",
              "characteristicValues": "string"
            }
          ]
        },
        "discounts": [
          {
            "id": "integer (int64)",
            "description": "string",
            "name": "string",
            "quantity": "integer (int64)",
            "type": "string",
            "pattern": "string",
            "unitOfMeasure": "string"
          }
        ],
        "price": {
          "currency": "number (double)",
          "pattern": "string",
          "unitOfMeasure": "string"
        },
        "taxes": [
          {
            "id": "integer (int64)",
            "description": "string",
            "name": "string",
            "quantity": "integer (int64)"
          }
        ]
      }
    ]
  },
  "tags": [
    {
      "id": "integer (int64)",
      "name": "string",
      "description": "string"
    }
  ]
}
Response Example (401 Unauthorized)
Response Example (404 Not Found)
Response Example (default )

Find all the Stores

GET /stores

Find all the Stores

Success

404 Not Found

Not Found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "storeID": "string",
    "r_id": "string",
    "s_name": "string",
    "s_address": "string",
    "s_email": "string",
    "opening_timings": "string",
    "s_cdate": "string"
  }
]
Response Example (404 Not Found)
Response Example (default )

Creates new store

POST /stores

Creates new store

payload of Store

Request Example
{
  "storeID": "string",
  "r_id": "string",
  "s_name": "string",
  "s_address": "string",
  "s_email": "string",
  "opening_timings": "string",
  "s_cdate": "string"
}
200 OK

Success

405 Method Not Allowed

Invalid Input

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (405 Method Not Allowed)
Response Example (default )

Find store by storeID

GET /stores/{id}

Find store by storeID

id

ID to retieve a Store

type
string
in
path

Success

401 Unauthorized

Invalid ID supplied

404 Not Found

Store not found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "storeID": "string",
  "r_id": "string",
  "s_name": "string",
  "s_address": "string",
  "s_email": "string",
  "opening_timings": "string",
  "s_cdate": "string"
}
Response Example (401 Unauthorized)
Response Example (404 Not Found)
Response Example (default )

Find all the Offers

GET /offers

Find all the Offers

200 OK

Success

404 Not Found

Not Found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "r_id": "string",
    "s_id": "string",
    "u_id": [
      "string"
    ],
    "title": "string",
    "desc": "string",
    "offer": "string",
    "imagename": "string",
    "s_date": "string (date)",
    "e_date": "string (date)",
    "mobileNotification": "string",
    "termsAndCondition": "string",
    "createdAt": "string (date)"
  }
]
Response Example (404 Not Found)
Response Example (default )

Creates new offer

POST /offers

Creates new offer

User to add an Offer

Request Example
{
  "r_id": "string",
  "s_id": "string",
  "u_id": [
    "string"
  ],
  "title": "string",
  "desc": "string",
  "offer": "string",
  "imagename": "string",
  "s_date": "string (date)",
  "e_date": "string (date)",
  "mobileNotification": "string",
  "termsAndCondition": "string",
  "createdAt": "string (date)"
}
200 OK

Success

405 Method Not Allowed

Invalid Input

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (405 Method Not Allowed)
Response Example (default )

Find offer by offerID

GET /offers/{id}

Find offer by offerID

id

ID or Offercode to retieve an Offer

type
string
in
path
200 OK

Success

401 Unauthorized

Invalid ID supplied

404 Not Found

Offer not found

Response Content-Types: application/json
Response Example (200 OK)
{
  "r_id": "string",
  "s_id": "string",
  "u_id": [
    "string"
  ],
  "title": "string",
  "desc": "string",
  "offer": "string",
  "imagename": "string",
  "s_date": "string (date)",
  "e_date": "string (date)",
  "mobileNotification": "string",
  "termsAndCondition": "string",
  "createdAt": "string (date)"
}
Response Example (401 Unauthorized)
Response Example (404 Not Found)

Find all the Retailers

GET /retailers

Find all the Retailers

Success

404 Not Found

Not Found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "r_name": "string",
    "r_brandName": "string",
    "r_registrationNumber": "string",
    "r_vatNumber": "string",
    "r_numberOfEmployees": "string",
    "r_country": "string",
    "r_firstName": "string",
    "r_lastName": "string",
    "r_phoneNumber": "string",
    "r_email": "string",
    "r_userName": "string",
    "r_addressLine1": "string",
    "r_addressLine2": "string",
    "r_logoname": "string",
    "r_termsAndCondition": "string",
    "r_cdate": "string (date)"
  }
]
Response Example (404 Not Found)
Response Example (default )

Creates new Retailer

POST /retailers

Creates new Retailer

payload of Retailer

Request Example
{
  "r_name": "string",
  "r_brandName": "string",
  "r_registrationNumber": "string",
  "r_vatNumber": "string",
  "r_numberOfEmployees": "string",
  "r_country": "string",
  "r_firstName": "string",
  "r_lastName": "string",
  "r_phoneNumber": "string",
  "r_email": "string",
  "r_userName": "string",
  "r_addressLine1": "string",
  "r_addressLine2": "string",
  "r_logoname": "string",
  "r_termsAndCondition": "string",
  "r_cdate": "string (date)"
}
200 OK

Success

405 Method Not Allowed

Invalid Input

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
"string"
Response Example (405 Method Not Allowed)
Response Example (default )

Find retailer by retailerID

GET /retailers/{id}

Find retailer by retailerID

id

ID to retieve a Retailer

type
string
in
path

Success

401 Unauthorized

Invalid ID supplied

404 Not Found

Retailer not found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
{
  "r_name": "string",
  "r_brandName": "string",
  "r_registrationNumber": "string",
  "r_vatNumber": "string",
  "r_numberOfEmployees": "string",
  "r_country": "string",
  "r_firstName": "string",
  "r_lastName": "string",
  "r_phoneNumber": "string",
  "r_email": "string",
  "r_userName": "string",
  "r_addressLine1": "string",
  "r_addressLine2": "string",
  "r_logoname": "string",
  "r_termsAndCondition": "string",
  "r_cdate": "string (date)"
}
Response Example (401 Unauthorized)
Response Example (404 Not Found)
Response Example (default )

Schema Definitions

TransactionPayload: object

id: string

transaction id

name: string

transaction name

description: string

transaction description

type: TypePayload
status: StatusPayload
versionNumber: string

transaction version number

creationDateTime: string (date)

transaction creation date and time

validityPeriod: ValidityPayload
details: DetailsPayload
relatedTransactions: object[]

related transactions to current transaction

channels: object[]

transaction channels

parts: PartsPayload
tags: object[]

transaction tags

Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "type": {
    "id": "number (double)",
    "name": "string",
    "description": "string"
  },
  "status": {
    "id": "string",
    "name": "string"
  },
  "versionNumber": "string",
  "creationDateTime": "string (date)",
  "validityPeriod": {
    "fromDate": "string (date)",
    "toDate": "string (date)"
  },
  "details": {
    "remarks": "string",
    "numberOfItemsPurchased": "number (double)"
  },
  "relatedTransactions": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "channels": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    }
  ],
  "parts": {
    "merchant": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    },
    "store": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      },
      "address": {
        "street": "string",
        "town": "string",
        "buildingName": "string",
        "buildingNumber": "integer (int64)",
        "country": "string",
        "county": "string",
        "occupant": "string",
        "postalCode": "integer (int64)",
        "primaryClassification": "string",
        "subLocality": "string",
        "subStreet": "string",
        "subUnit": "string"
      }
    },
    "payments": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "type": "string",
        "paymentReference": "string",
        "cardReference": "string",
        "cardType": "string",
        "terminalId": "string",
        "date": "string (date)",
        "amount": "number (double)",
        "balance": "number (double)",
        "change": "number (double)",
        "authCode": "string"
      }
    ],
    "customer": {
      "id": "string",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      },
      "address": {
        "street": "string",
        "town": "string",
        "buildingName": "string",
        "buildingNumber": "integer (int64)",
        "country": "string",
        "county": "string",
        "occupant": "string",
        "postalCode": "integer (int64)",
        "primaryClassification": "string",
        "subLocality": "string",
        "subStreet": "string",
        "subUnit": "string"
      }
    },
    "agent": {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "status": {
        "id": "string",
        "name": "string"
      }
    },
    "loyalty": {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)",
      "type": "string"
    },
    "discounts": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)",
        "type": "string",
        "pattern": "string",
        "unitOfMeasure": "string"
      }
    ],
    "taxes": [
      {
        "id": "integer (int64)",
        "description": "string",
        "name": "string",
        "quantity": "integer (int64)"
      }
    ],
    "price": {
      "currency": "number (double)",
      "pattern": "string",
      "unitOfMeasure": "string"
    },
    "lineItems": [
      {
        "customerProduct": {
          "id": "number (double)",
          "name": "string",
          "description": "string",
          "type": {
            "id": "number (double)",
            "name": "string",
            "description": "string"
          },
          "productType": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "productSubType": {
              "id": "integer (int64)",
              "name": "string",
              "description": "string"
            }
          },
          "status": {
            "id": "string",
            "name": "string"
          },
          "warranty": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "validityPeriod": {
              "fromDate": "string (date)",
              "toDate": "string (date)"
            }
          },
          "quantity": "integer (int64)",
          "specifications": [
            {
              "id": "integer (int64)",
              "name": "string",
              "description": "string",
              "characteristicValues": "string"
            }
          ]
        },
        "discounts": [
          {
            "id": "integer (int64)",
            "description": "string",
            "name": "string",
            "quantity": "integer (int64)",
            "type": "string",
            "pattern": "string",
            "unitOfMeasure": "string"
          }
        ],
        "price": {
          "currency": "number (double)",
          "pattern": "string",
          "unitOfMeasure": "string"
        },
        "taxes": [
          {
            "id": "integer (int64)",
            "description": "string",
            "name": "string",
            "quantity": "integer (int64)"
          }
        ]
      }
    ]
  },
  "tags": [
    {
      "id": "integer (int64)",
      "name": "string",
      "description": "string"
    }
  ]
}

TypePayload: object

id: number (double)

type id

name: string

type name

description: string

type description

Example
{
  "id": "number (double)",
  "name": "string",
  "description": "string"
}

StatusPayload: object

id: string

status id

name: string

status name

Example
{
  "id": "string",
  "name": "string"
}

ValidityPayload: object

fromDate: string (date)

validity starting date

toDate: string (date)

validity ending date

Example
{
  "fromDate": "string (date)",
  "toDate": "string (date)"
}

DetailsPayload: object

remarks: string

detail remarks

numberOfItemsPurchased: number (double)

number of item purchased

Example
{
  "remarks": "string",
  "numberOfItemsPurchased": "number (double)"
}

RelatedTransactionPayload: object

id: integer (int64)

related transaction id

description: string

related transaction description

name: string

related transaction name

type: string

related transaction type

status: StatusPayload
Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  }
}

ChannelPayload: object

id: integer (int64)

channel id

description: string

channel description

name: string

channel name

type: string

channel type

status: StatusPayload
Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  }
}

PartsPayload: object

merchant: MerchantPayload
store: StorePayload
payments: object[]

payment details

customer: CustomerPayload
agent: AgentPayload
loyalty: LoyaltyPayload
discounts: object[]

discount details

taxes: object[]

tax details

price: PricePayload
lineItems: object[]

lineitem details

Example
{
  "merchant": {
    "id": "string",
    "description": "string",
    "name": "string",
    "type": "string",
    "status": {
      "id": "string",
      "name": "string"
    }
  },
  "store": {
    "id": "string",
    "description": "string",
    "name": "string",
    "type": "string",
    "status": {
      "id": "string",
      "name": "string"
    },
    "address": {
      "street": "string",
      "town": "string",
      "buildingName": "string",
      "buildingNumber": "integer (int64)",
      "country": "string",
      "county": "string",
      "occupant": "string",
      "postalCode": "integer (int64)",
      "primaryClassification": "string",
      "subLocality": "string",
      "subStreet": "string",
      "subUnit": "string"
    }
  },
  "payments": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "type": "string",
      "paymentReference": "string",
      "cardReference": "string",
      "cardType": "string",
      "terminalId": "string",
      "date": "string (date)",
      "amount": "number (double)",
      "balance": "number (double)",
      "change": "number (double)",
      "authCode": "string"
    }
  ],
  "customer": {
    "id": "string",
    "description": "string",
    "name": "string",
    "type": "string",
    "status": {
      "id": "string",
      "name": "string"
    },
    "address": {
      "street": "string",
      "town": "string",
      "buildingName": "string",
      "buildingNumber": "integer (int64)",
      "country": "string",
      "county": "string",
      "occupant": "string",
      "postalCode": "integer (int64)",
      "primaryClassification": "string",
      "subLocality": "string",
      "subStreet": "string",
      "subUnit": "string"
    }
  },
  "agent": {
    "id": "integer (int64)",
    "description": "string",
    "name": "string",
    "type": "string",
    "status": {
      "id": "string",
      "name": "string"
    }
  },
  "loyalty": {
    "id": "integer (int64)",
    "description": "string",
    "name": "string",
    "quantity": "integer (int64)",
    "type": "string"
  },
  "discounts": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)",
      "type": "string",
      "pattern": "string",
      "unitOfMeasure": "string"
    }
  ],
  "taxes": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)"
    }
  ],
  "price": {
    "currency": "number (double)",
    "pattern": "string",
    "unitOfMeasure": "string"
  },
  "lineItems": [
    {
      "customerProduct": {
        "id": "number (double)",
        "name": "string",
        "description": "string",
        "type": {
          "id": "number (double)",
          "name": "string",
          "description": "string"
        },
        "productType": {
          "id": "integer (int64)",
          "name": "string",
          "description": "string",
          "productSubType": {
            "id": "integer (int64)",
            "name": "string",
            "description": "string"
          }
        },
        "status": {
          "id": "string",
          "name": "string"
        },
        "warranty": {
          "id": "integer (int64)",
          "name": "string",
          "description": "string",
          "validityPeriod": {
            "fromDate": "string (date)",
            "toDate": "string (date)"
          }
        },
        "quantity": "integer (int64)",
        "specifications": [
          {
            "id": "integer (int64)",
            "name": "string",
            "description": "string",
            "characteristicValues": "string"
          }
        ]
      },
      "discounts": [
        {
          "id": "integer (int64)",
          "description": "string",
          "name": "string",
          "quantity": "integer (int64)",
          "type": "string",
          "pattern": "string",
          "unitOfMeasure": "string"
        }
      ],
      "price": {
        "currency": "number (double)",
        "pattern": "string",
        "unitOfMeasure": "string"
      },
      "taxes": [
        {
          "id": "integer (int64)",
          "description": "string",
          "name": "string",
          "quantity": "integer (int64)"
        }
      ]
    }
  ]
}

MerchantPayload: object

id: string

retailer id

description: string

retailer description

name: string

retailer name

type: string

retailer type

status: StatusPayload
Example
{
  "id": "string",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  }
}

StorePayload: object

id: string

store id

description: string

store description

name: string

store name

type: string

store type

status: StatusPayload
address: AddressPayload
Example
{
  "id": "string",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  },
  "address": {
    "street": "string",
    "town": "string",
    "buildingName": "string",
    "buildingNumber": "integer (int64)",
    "country": "string",
    "county": "string",
    "occupant": "string",
    "postalCode": "integer (int64)",
    "primaryClassification": "string",
    "subLocality": "string",
    "subStreet": "string",
    "subUnit": "string"
  }
}

AddressPayload: object

street: string

street

town: string

town

buildingName: string

building name

buildingNumber: integer (int64)

building number

country: string

country

county: string

county

occupant: string

occupant

postalCode: integer (int64)

postal code

primaryClassification: string

primary claasification

subLocality: string

sub locality

subStreet: string

sub street

subUnit: string

sub unit

Example
{
  "street": "string",
  "town": "string",
  "buildingName": "string",
  "buildingNumber": "integer (int64)",
  "country": "string",
  "county": "string",
  "occupant": "string",
  "postalCode": "integer (int64)",
  "primaryClassification": "string",
  "subLocality": "string",
  "subStreet": "string",
  "subUnit": "string"
}

PaymentPayload: object

id: integer (int64)

payment id

description: string

payment description

name: string

payment name

type: string

payment type

paymentReference: string

payment reference

cardReference: string

payment card reference

cardType: string

payment card type

terminalId: string

payment terminal id

date: string (date)

payment date

amount: number (double)

payment amount

balance: number (double)

payment balance

change: number (double)

payment change

authCode: string

payment authcode

Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "type": "string",
  "paymentReference": "string",
  "cardReference": "string",
  "cardType": "string",
  "terminalId": "string",
  "date": "string (date)",
  "amount": "number (double)",
  "balance": "number (double)",
  "change": "number (double)",
  "authCode": "string"
}

CustomerPayload: object

id: string

customer mypop id or email id

description: string

customer description

name: string

customer name

type: string

customer type

status: StatusPayload
address: AddressPayload
Example
{
  "id": "string",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  },
  "address": {
    "street": "string",
    "town": "string",
    "buildingName": "string",
    "buildingNumber": "integer (int64)",
    "country": "string",
    "county": "string",
    "occupant": "string",
    "postalCode": "integer (int64)",
    "primaryClassification": "string",
    "subLocality": "string",
    "subStreet": "string",
    "subUnit": "string"
  }
}

AgentPayload: object

id: integer (int64)

agent id

description: string

agent description

name: string

agent name

type: string

agent type

status: StatusPayload
Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  }
}

LoyaltyPayload: object

id: integer (int64)

loyalty id

description: string

loyalty description

name: string

loyalty name

quantity: integer (int64)

loyalty quantity

type: string

loyalty type

Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "quantity": "integer (int64)",
  "type": "string"
}

DiscountPayload: object

id: integer (int64)

discount id

description: string

discount description

name: string

discount name

quantity: integer (int64)

discount quantity

type: string

discount type

pattern: string

discount pattern

unitOfMeasure: string

discount unit of measure

Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "quantity": "integer (int64)",
  "type": "string",
  "pattern": "string",
  "unitOfMeasure": "string"
}

TaxPayload: object

id: integer (int64)

tax id

description: string

tax description

name: string

tax name

quantity: integer (int64)
Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "quantity": "integer (int64)"
}

PricePayload: object

currency: number (double)
pattern: string
unitOfMeasure: string
Example
{
  "currency": "number (double)",
  "pattern": "string",
  "unitOfMeasure": "string"
}

LineItemPayload: object

customerProduct: CustomerProductPayload
discounts: object[]

lineitem discount

price: PricePayload
taxes: object[]

lineitem taxes

Example
{
  "customerProduct": {
    "id": "number (double)",
    "name": "string",
    "description": "string",
    "type": {
      "id": "number (double)",
      "name": "string",
      "description": "string"
    },
    "productType": {
      "id": "integer (int64)",
      "name": "string",
      "description": "string",
      "productSubType": {
        "id": "integer (int64)",
        "name": "string",
        "description": "string"
      }
    },
    "status": {
      "id": "string",
      "name": "string"
    },
    "warranty": {
      "id": "integer (int64)",
      "name": "string",
      "description": "string",
      "validityPeriod": {
        "fromDate": "string (date)",
        "toDate": "string (date)"
      }
    },
    "quantity": "integer (int64)",
    "specifications": [
      {
        "id": "integer (int64)",
        "name": "string",
        "description": "string",
        "characteristicValues": "string"
      }
    ]
  },
  "discounts": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)",
      "type": "string",
      "pattern": "string",
      "unitOfMeasure": "string"
    }
  ],
  "price": {
    "currency": "number (double)",
    "pattern": "string",
    "unitOfMeasure": "string"
  },
  "taxes": [
    {
      "id": "integer (int64)",
      "description": "string",
      "name": "string",
      "quantity": "integer (int64)"
    }
  ]
}

CustomerProductPayload: object

id: number (double)

customer product id

name: string

customer product name

description: string

customer product description

type: TypePayload
productType: ProductTypePayload
status: StatusPayload
warranty: WarrantyPayload
quantity: integer (int64)

customer product quantity

specifications: object[]

customer product specification

Example
{
  "id": "number (double)",
  "name": "string",
  "description": "string",
  "type": {
    "id": "number (double)",
    "name": "string",
    "description": "string"
  },
  "productType": {
    "id": "integer (int64)",
    "name": "string",
    "description": "string",
    "productSubType": {
      "id": "integer (int64)",
      "name": "string",
      "description": "string"
    }
  },
  "status": {
    "id": "string",
    "name": "string"
  },
  "warranty": {
    "id": "integer (int64)",
    "name": "string",
    "description": "string",
    "validityPeriod": {
      "fromDate": "string (date)",
      "toDate": "string (date)"
    }
  },
  "quantity": "integer (int64)",
  "specifications": [
    {
      "id": "integer (int64)",
      "name": "string",
      "description": "string",
      "characteristicValues": "string"
    }
  ]
}

ProductTypePayload: object

id: integer (int64)

product type id

name: string

product type name

description: string

product type description

productSubType: ProductSubTypePayload
Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "productSubType": {
    "id": "integer (int64)",
    "name": "string",
    "description": "string"
  }
}

ProductSubTypePayload: object

id: integer (int64)

product sub type id

name: string

product sub type name

description: string

product sub type description

Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string"
}

WarrantyPayload: object

id: integer (int64)

warranty id

name: string

warranty name

description: string

warranty description

validityPeriod: ValidityPayload
Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "validityPeriod": {
    "fromDate": "string (date)",
    "toDate": "string (date)"
  }
}

SpecificationPayload: object

id: integer (int64)

specification id

name: string

specification name

description: string

specification description

characteristicValues: string

specification characterstic values

Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "characteristicValues": "string"
}

TagPayload: object

id: integer (int64)

transaction tag id

name: string

transaction tag name

description: string

transaction tag description

Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string"
}

OfferPayload: object

r_id: string

retailer ID

s_id: string

store ID

u_id: string[]

unique ID for offer

title: string

offer title

desc: string

offer description

offer: string

offer name

imagename: string
s_date: string (date)

offer starting date

e_date: string (date)

offer ending date

mobileNotification: string

offer mobilenotification value

termsAndCondition: string

offer terms and condition

createdAt: string (date)

offer creation date

Example
{
  "r_id": "string",
  "s_id": "string",
  "u_id": [
    "string"
  ],
  "title": "string",
  "desc": "string",
  "offer": "string",
  "imagename": "string",
  "s_date": "string (date)",
  "e_date": "string (date)",
  "mobileNotification": "string",
  "termsAndCondition": "string",
  "createdAt": "string (date)"
}

RetailerPayload: object

r_name: string

retailer name

r_brandName: string

reatiler brand name

r_registrationNumber: string

retailer registartion number

r_vatNumber: string

retailer vat number

r_numberOfEmployees: string

total number of employees

r_country: string

country

r_firstName: string

retailer first name

r_lastName: string

retailer last name

r_phoneNumber: string

retailer phone number

r_email: string

retailer contact email address

r_userName: string

username for retailer

r_addressLine1: string

addressline1

r_addressLine2: string

addressline2

r_logoname: string

retailerlogoname

r_termsAndCondition: string

comany terms and condition

r_cdate: string (date)

retailer creation date in mypop

Example
{
  "r_name": "string",
  "r_brandName": "string",
  "r_registrationNumber": "string",
  "r_vatNumber": "string",
  "r_numberOfEmployees": "string",
  "r_country": "string",
  "r_firstName": "string",
  "r_lastName": "string",
  "r_phoneNumber": "string",
  "r_email": "string",
  "r_userName": "string",
  "r_addressLine1": "string",
  "r_addressLine2": "string",
  "r_logoname": "string",
  "r_termsAndCondition": "string",
  "r_cdate": "string (date)"
}

StoreValuePayload: object

storeID: string

store Id which will be auto created

r_id: string

retailer id for the store

s_name: string

store name

s_address: string

store address

s_email: string

store conatct email address

opening_timings: string

store opening time

s_cdate: string

store creation date

Example
{
  "storeID": "string",
  "r_id": "string",
  "s_name": "string",
  "s_address": "string",
  "s_email": "string",
  "opening_timings": "string",
  "s_cdate": "string"
}