Implements backend functions for Shipping area API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Shipping

GET /api/shipping/shippingoptions

200 OK
ShippingOptionCollectionItem

OK

type
ShippingOptionCollectionItem
Response Example (200 OK) 
[
  {
    "ShippingOptionId": "integer",
    "Name": "string",
    "Account": "string",
    "IsActive": "boolean",
    "Description": "string",
    "Actions": "string"
  }
]
Shipping

GET /api/shipping/shippingoptions/{shippingoptionid}

shippingoptionid: integer
in path

(no description)

200 OK
ShippingOptionAddEditModel

OK

Response Example (200 OK) 
{
  "ShippingOptionId": "integer",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "AccountId": "integer"
}
Shipping

POST /api/shipping/shippingoptions/{shippingoptionid}

ShippingOptionAddEditModel

undefined

shippingoptionid: integer
in path

(no description)

Request Example
{
  "ShippingOptionId": "integer",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "AccountId": "integer"
}
200 OK
ShippingOptionCollectionItem

OK

Response Example (200 OK) 
{
  "ShippingOptionId": "integer",
  "Name": "string",
  "Account": "string",
  "IsActive": "boolean",
  "Description": "string",
  "Actions": "string"
}
Shipping

DELETE /api/shipping/shippingoptions/{shippingoptionid}

shippingoptionid: integer
in path

(no description)

200 OK

OK

Shipping

GET /api/shipping/shippingoptions/{shippingoptionid}/pricetiers

shippingoptionid: integer
in path

(no description)

200 OK
ShippingOptionPriceTierFeesViewModel

OK

Response Example (200 OK) 
{
  "ShippingOptionId": "integer",
  "PriceFees": "string"
}
Shipping

POST /api/shipping/shippingoptions/{shippingoptionid}/pricetiers

ShippingOptionPriceTierFeesViewModel

undefined

shippingoptionid: integer
in path

(no description)

Request Example
{
  "ShippingOptionId": "integer",
  "PriceFees": "string"
}
200 OK

OK

Shipping

GET /api/shipping/shippingpricetiers

200 OK
ShippingPriceTiersViewModel

OK

Response Example (200 OK) 
{
  "PriceTiers": "string"
}
Shipping

POST /api/shipping/shippingpricetiers

ShippingPriceTiersViewModel

undefined

Request Example
{
  "PriceTiers": "string"
}
200 OK

OK

Schema Definitions

ShippingOptionCollectionItem: object

ShippingOptionId: integer
Name: string
Account: string
IsActive: boolean
Description: string
Actions: string
Example
{
  "ShippingOptionId": "integer",
  "Name": "string",
  "Account": "string",
  "IsActive": "boolean",
  "Description": "string",
  "Actions": "string"
}

ShippingOptionAddEditModel: object

ShippingOptionId: integer
Name: string
Description: string
IsActive: boolean
AccountId: integer
Example
{
  "ShippingOptionId": "integer",
  "Name": "string",
  "Description": "string",
  "IsActive": "boolean",
  "AccountId": "integer"
}

Object: object

Example
"object"

ShippingPriceTiersViewModel: object

PriceTiers: string
Example
{
  "PriceTiers": "string"
}

ShippingOptionPriceTierFeesViewModel: object

ShippingOptionId: integer
PriceFees: string
Example
{
  "ShippingOptionId": "integer",
  "PriceFees": "string"
}
Documentation by Spectacle