Transaction API API Reference

Transactions 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

200 OK

Success

404 Not Found

Not Found

default

Internal Server Error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "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"
    }
  }
]
Response Example (404 Not Found)
Response Example (default )

Creates new store

POST /stores

Creates new store

payload of Store

Request 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"
  }
}
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
200 OK

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)
{
  "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"
  }
}
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)"
  }
]
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)"
}
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)"
}
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_address": "string",
    "r_logoname": "string",
    "r_email": "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_address": "string",
  "r_logoname": "string",
  "r_email": "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_address": "string",
  "r_logoname": "string",
  "r_email": "string",
  "r_cdate": "string (date)"
}
Response Example (401 Unauthorized)
Response Example (404 Not Found)
Response Example (default )

Schema Definitions

TransactionPayload: object

id: string
name: string
description: string
type: TypePayload
status: StatusPayload
versionNumber: string
creationDateTime: string (date)
validityPeriod: ValidityPayload
details: DetailsPayload
relatedTransactions: object[]
channels: object[]
parts: PartsPayload
tags: object[]
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)
name: string
description: string
Example
{
  "id": "number (double)",
  "name": "string",
  "description": "string"
}

StatusPayload: object

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

ValidityPayload: object

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

DetailsPayload: object

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

RelatedTransactionPayload: object

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

ChannelPayload: object

id: integer (int64)
description: string
name: string
type: string
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[]
customer: CustomerPayload
agent: AgentPayload
loyalty: LoyaltyPayload
discounts: object[]
taxes: object[]
price: PricePayload
lineItems: object[]
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
description: string
name: string
type: string
status: StatusPayload
Example
{
  "id": "string",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  }
}

StorePayload: object

id: string
description: string
name: string
type: string
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
town: string
buildingName: string
buildingNumber: integer (int64)
country: string
county: string
occupant: string
postalCode: integer (int64)
primaryClassification: string
subLocality: string
subStreet: string
subUnit: string
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)
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
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
description: string
name: string
type: string
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)
description: string
name: string
type: string
status: StatusPayload
Example
{
  "id": "integer (int64)",
  "description": "string",
  "name": "string",
  "type": "string",
  "status": {
    "id": "string",
    "name": "string"
  }
}

LoyaltyPayload: object

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

DiscountPayload: object

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

TaxPayload: object

id: integer (int64)
description: string
name: string
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[]
price: PricePayload
taxes: object[]
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)
name: string
description: string
type: TypePayload
productType: ProductTypePayload
status: StatusPayload
warranty: WarrantyPayload
quantity: integer (int64)
specifications: object[]
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)
name: string
description: string
productSubType: ProductSubTypePayload
Example
{
  "id": "integer (int64)",
  "name": "string",
  "description": "string",
  "productSubType": {
    "id": "integer (int64)",
    "name": "string",
    "description": "string"
  }
}

ProductSubTypePayload: object

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

WarrantyPayload: object

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

SpecificationPayload: object

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

TagPayload: object

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

OfferPayload: object

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)
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)"
}

RetailerPayload: object

r_name: string
r_address: string
r_logoname: string
r_email: string
r_cdate: string (date)
Example
{
  "r_name": "string",
  "r_address": "string",
  "r_logoname": "string",
  "r_email": "string",
  "r_cdate": "string (date)"
}