Create Pricelist

Creates a price list.

PreviousPricelist Item States NextList Pricelists

Last updated 1 month ago

Was this helpful?

POST/v1/catalog/price-lists

Body

currencystring

precision*integer (int32)

defaultMarkupnullable number (double)

notesnullable string

externalIdsobject

product*object

Response

Created

Body

idstring

auditobject

$metaobject

hrefstring

currencystring

precisioninteger (int32)

defaultMarkupnumber (double)

notesnullable string

externalIdsobject

statisticsobject

productobject

vendorobject

Request

const response = await fetch('/v1/catalog/price-lists', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "precision": 1,
      "externalIds": {},
      "product": {}
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-02-05T02:47:06.810Z",
      "by": {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-05T02:47:06.810Z",
            "by": "[Circular Reference]"
          },
          "updated": {
            "at": "2025-02-05T02:47:06.810Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "icon": "text"
      }
    },
    "updated": {
      "at": "2025-02-05T02:47:06.810Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "href": "text",
  "currency": "text",
  "precision": 1,
  "defaultMarkup": 1,
  "notes": "text",
  "externalIds": {
    "vendor": "text"
  },
  "statistics": {
    "sellers": 1,
    "listings": 1,
    "priceListItems": 1,
    "purchasePriceItems": 1,
    "purchasePriceCompleteness": 1,
    "salesPriceItems": 1,
    "salesPriceCompleteness": 1,
    "averageMarkup": 1,
    "averageMargin": 1
  },
  "product": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "published": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "pending": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "unpublished": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "text",
    "name": "text",
    "shortDescription": "text",
    "longDescription": "text",
    "externalIds": {
      "operations": "text"
    },
    "website": "text",
    "icon": "text",
    "status": "text",
    "vendor": {
      "id": "text",
      "audit": {
        "created": {
          "at": "2025-02-05T02:47:06.810Z",
          "by": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-02-05T02:47:06.810Z",
                "by": "[Circular Reference]"
              },
              "updated": {
                "at": "2025-02-05T02:47:06.810Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "text",
            "name": "text",
            "icon": "text"
          }
        },
        "updated": {
          "at": "2025-02-05T02:47:06.810Z",
          "by": "[Circular Reference]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "href": "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"
      },
      "icon": "text",
      "technicalSupportEmail": "hello@example.com",
      "website": "text",
      "description": "text",
      "name": "text",
      "groups": [
        {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": {
                "id": "text",
                "audit": {
                  "created": {
                    "at": "2025-02-05T02:47:06.810Z",
                    "by": "[Circular Reference]"
                  },
                  "updated": {
                    "at": "2025-02-05T02:47:06.810Z",
                    "by": "[Circular Reference]"
                  }
                },
                "$meta": {
                  "omitted": [
                    "text"
                  ]
                },
                "href": "text",
                "name": "text",
                "icon": "text"
              }
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "description": "text",
          "account": {
            "id": "text",
            "audit": {
              "created": {
                "at": "2025-02-05T02:47:06.810Z",
                "by": {
                  "id": "text",
                  "audit": {
                    "created": {
                      "at": "2025-02-05T02:47:06.810Z",
                      "by": "[Circular Reference]"
                    },
                    "updated": {
                      "at": "2025-02-05T02:47:06.810Z",
                      "by": "[Circular Reference]"
                    }
                  },
                  "$meta": {
                    "omitted": [
                      "text"
                    ]
                  },
                  "href": "text",
                  "name": "text",
                  "icon": "text"
                }
              },
              "updated": {
                "at": "2025-02-05T02:47:06.810Z",
                "by": "[Circular Reference]"
              }
            },
            "$meta": {
              "omitted": [
                "text"
              ]
            },
            "href": "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"
            },
            "icon": "text",
            "technicalSupportEmail": "hello@example.com",
            "website": "text",
            "description": "text",
            "name": "text",
            "groups": "[Circular Reference]"
          },
          "modules": [
            "[Circular Reference]"
          ],
          "logo": "text",
          "isDefault": true,
          "users": [
            "[Circular Reference]"
          ],
          "buyers": [
            "[Circular Reference]"
          ]
        }
      ]
    },
    "settings": {
      "productOrdering": true,
      "productRequests": {
        "enabled": true,
        "name": "text",
        "label": "text"
      },
      "itemSelection": true,
      "orderQueueChanges": true,
      "preValidation": {
        "purchaseOrderDraft": true,
        "purchaseOrderQuerying": true,
        "changeOrderDraft": true,
        "terminationOrder": true,
        "productRequest": true
      },
      "splitBilling": {
        "enabled": true,
        "type": "text"
      }
    },
    "statistics": {
      "itemCount": 1,
      "ordersPlacedCount": 1,
      "agreementCount": 1,
      "subscriptionCount": 1,
      "requestCount": 1
    }
  },
  "vendor": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "text",
          "name": "text",
          "icon": "text"
        }
      },
      "updated": {
        "at": "2025-02-05T02:47:06.810Z",
        "by": "[Circular Reference]"
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "href": "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"
    },
    "icon": "text",
    "technicalSupportEmail": "hello@example.com",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "audit": {
          "created": {
            "at": "2025-02-05T02:47:06.810Z",
            "by": {
              "id": "text",
              "audit": {
                "created": {
                  "at": "2025-02-05T02:47:06.810Z",
                  "by": "[Circular Reference]"
                },
                "updated": {
                  "at": "2025-02-05T02:47:06.810Z",
                  "by": "[Circular Reference]"
                }
              },
              "$meta": {
                "omitted": [
                  "text"
                ]
              },
              "href": "text",
              "name": "text",
              "icon": "text"
            }
          },
          "updated": {
            "at": "2025-02-05T02:47:06.810Z",
            "by": "[Circular Reference]"
          }
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "href": "text",
        "name": "text",
        "description": "text",
        "account": {
          "id": "text",
          "audit": {
            "created": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": {
                "id": "text",
                "audit": {
                  "created": {
                    "at": "2025-02-05T02:47:06.810Z",
                    "by": "[Circular Reference]"
                  },
                  "updated": {
                    "at": "2025-02-05T02:47:06.810Z",
                    "by": "[Circular Reference]"
                  }
                },
                "$meta": {
                  "omitted": [
                    "text"
                  ]
                },
                "href": "text",
                "name": "text",
                "icon": "text"
              }
            },
            "updated": {
              "at": "2025-02-05T02:47:06.810Z",
              "by": "[Circular Reference]"
            }
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "href": "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"
          },
          "icon": "text",
          "technicalSupportEmail": "hello@example.com",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": "[Circular Reference]"
        },
        "modules": [
          "[Circular Reference]"
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          "[Circular Reference]"
        ],
        "buyers": [
          "[Circular Reference]"
        ]
      }
    ]
  }
}