Create Pricing Policy

Create a new pricing policy.

post

Body

application/jsontext/jsonapplication/*+json

namestringOptional

externalIdsall ofOptional

clientall ofOptional

eligibilityall ofRequired

markupnumber · double | nullableOptional

marginnumber · double | nullableOptional

notesstring | nullableOptional

Responses

201

Created

application/json

400

Bad Request

application/json

403

Forbidden

application/json

409

Conflict

application/json

500

Internal Server Error

post

HTTPcURLJavaScriptPython

POST /public/v1/catalog/pricing-policies HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 183

{
  "name": "text",
  "externalIds": {
    "operations": "text"
  },
  "client": {
    "id": "text"
  },
  "eligibility": {
    "client": true,
    "partner": true
  },
  "markup": 1,
  "margin": 1,
  "notes": "text",
  "products": [
    {
      "id": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-21T22:58:03.933Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-21T22:58:03.933Z",
      "by": "[Circular Reference]"
    },
    "activated": {
      "at": "2025-08-21T22:58:03.933Z",
      "by": "[Circular Reference]"
    },
    "deactivated": {
      "at": "2025-08-21T22:58:03.933Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "externalIds": {
    "operations": "text"
  },
  "client": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "Client",
    "status": "Active",
    "serviceLevel": "Express",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "markup": 1,
  "margin": 1,
  "notes": "text",
  "products": [
    {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]",
        "published": "[Circular Reference]",
        "pending": "[Circular Reference]",
        "unpublished": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "shortDescription": "text",
      "longDescription": "text",
      "externalIds": {
        "operations": "text",
        "defaultErpItem": "text"
      },
      "website": "text",
      "icon": "text",
      "status": "text",
      "vendor": {
        "id": "text",
        "icon": "text",
        "type": "Client",
        "status": "Active",
        "name": "text"
      },
      "settings": {
        "productOrdering": true,
        "productRequests": {
          "enabled": true,
          "name": "text",
          "label": "text"
        },
        "itemSelection": true,
        "orderQueueChanges": true,
        "preValidation": {
          "purchaseOrderDraft": true,
          "purchaseOrderQuerying": true,
          "changeOrderDraft": true,
          "configurationOrderDraft": true,
          "terminationOrder": true,
          "productRequest": true
        },
        "splitBilling": {
          "enabled": true,
          "type": "text"
        },
        "subscriptionCessation": {
          "enabled": true,
          "mode": "Termination"
        }
      },
      "statistics": {
        "itemCount": 1,
        "ordersPlacedCount": 1,
        "agreementCount": 1,
        "subscriptionCount": 1,
        "requestCount": 1
      }
    }
  ],
  "status": "None",
  "statistics": {
    "orders": 1,
    "attachments": 1
  }
}