RetrieveOrderCustomAttribute

//native

type Square = {

  token: string;

};

/**

 * RetrieveOrderCustomAttribute

 * Retrieves a [custom attribute]($m/CustomAttribute) associated with an order.

You can use the `with_definition` query parameter to also retrieve the custom attribute definition

in the same call.

To retrieve a custom attribute owned by another application, the `visibility` setting must be

`VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes

also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

 */

export async function main(

  auth: Square,

  order_id: string,

  custom_attribute_key: string,

  version: string | undefined,

  with_definition: string | undefined,

) {

  const url = new URL(

    `https://connect.squareup.com/v2/orders/${order_id}/custom-attributes/${custom_attribute_key}`,

  );

  for (const [k, v] of [

    ["version", version],

    ["with_definition", with_definition],

  ]) {

    if (v !== undefined && v !== "" && k !== undefined) {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Bearer " + auth.token,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}